ArenaData Cluster Manager API

Version: 1.0

Intro

Cluster: Set of hosts and services

Host: Abstract container for components

Service: Set of components

Component: Piece of software

HostComponent: Map between hosts and components of services

Task: Service action at work. Consists of one or more jobs

Job: Minimal quantum of action. Run ansible playbook to do actual work

adcm

list

GET /api/v1/adcm/

List adcm object

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

read

GET /api/v1/adcm/{adcm_id}/

Show adcm object

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
adcm_id required

action > list

GET /api/v1/adcm/{adcm_id}/action/

List all actions of a specified object

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
adcm_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
button
button_is_null

action > read

GET /api/v1/adcm/{adcm_id}/action/{action_id}/

Show specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
adcm_id required
action_id required

action > run > create

POST /api/v1/adcm/{adcm_id}/action/{action_id}/run/

Ran specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
adcm_id required
action_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
config
attr
hc
hosts
verbose

config > list

GET /api/v1/adcm/{adcm_id}/config/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
adcm_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > current > list

GET /api/v1/adcm/{adcm_id}/config/current/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
adcm_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > history > list

GET /api/v1/adcm/{adcm_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
adcm_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > history > create

POST /api/v1/adcm/{adcm_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
adcm_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
config required
attr

config > history > read

GET /api/v1/adcm/{adcm_id}/config/history/{version}/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
adcm_id required
version required

config > history > restore > partial_update

PATCH /api/v1/adcm/{adcm_id}/config/history/{version}/restore/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
adcm_id required
version required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
attr

config > previous > list

GET /api/v1/adcm/{adcm_id}/config/previous/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
adcm_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

cluster

list

GET /api/v1/cluster/

List of all existing clusters

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
prototype_id
orderingWhich field to use when ordering the results.

create

POST /api/v1/cluster/

Create new cluster

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
prototype_id required id of cluster type
name required cluster name
description cluster description

read

GET /api/v1/cluster/{cluster_id}/

Show cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

partial_update

PATCH /api/v1/cluster/{cluster_id}/

Edit cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
prototype_id id of cluster type
name cluster name
description cluster description

delete

DELETE /api/v1/cluster/{cluster_id}/

Remove cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

action > list

GET /api/v1/cluster/{cluster_id}/action/

List all actions of a specified object

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
button
button_is_null

action > read

GET /api/v1/cluster/{cluster_id}/action/{action_id}/

Show specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
action_id required

action > run > create

POST /api/v1/cluster/{cluster_id}/action/{action_id}/run/

Ran specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
action_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
config
attr
hc
hosts
verbose

bind > list

GET /api/v1/cluster/{cluster_id}/bind/

List all binds of specified cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

bind > create

POST /api/v1/cluster/{cluster_id}/bind/

Bind two clusters

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

bind > read

GET /api/v1/cluster/{cluster_id}/bind/{bind_id}/

Show specified bind of specified cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
bind_id required

bind > delete

DELETE /api/v1/cluster/{cluster_id}/bind/{bind_id}/

Unbind specified bind of specified cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
bind_id required

config > list

GET /api/v1/cluster/{cluster_id}/config/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > current > list

GET /api/v1/cluster/{cluster_id}/config/current/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > history > list

GET /api/v1/cluster/{cluster_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > history > create

POST /api/v1/cluster/{cluster_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
config required
attr

config > history > read

GET /api/v1/cluster/{cluster_id}/config/history/{version}/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
version required

config > history > restore > partial_update

PATCH /api/v1/cluster/{cluster_id}/config/history/{version}/restore/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
version required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
attr

config > previous > list

GET /api/v1/cluster/{cluster_id}/config/previous/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

host > list

GET /api/v1/cluster/{cluster_id}/host/

List all hosts

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
cluster_id
prototype_id
provider_id
fqdn
cluster_is_null
provider_is_null
orderingWhich field to use when ordering the results.

host > create

POST /api/v1/cluster/{cluster_id}/host/

Create host

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
host_id required

host > read

GET /api/v1/cluster/{cluster_id}/host/{host_id}/

Show host

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
host_id required

host > delete

DELETE /api/v1/cluster/{cluster_id}/host/{host_id}/

Delete host

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
host_id required

host > action > list

GET /api/v1/cluster/{cluster_id}/host/{host_id}/action/

List all actions of a specified object

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
button
button_is_null

host > action > read

GET /api/v1/cluster/{cluster_id}/host/{host_id}/action/{action_id}/

Show specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
host_id required
action_id required

host > action > run > create

POST /api/v1/cluster/{cluster_id}/host/{host_id}/action/{action_id}/run/

Ran specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
host_id required
action_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
config
attr
hc
hosts
verbose

host > config > list

GET /api/v1/cluster/{cluster_id}/host/{host_id}/config/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

host > config > current > list

GET /api/v1/cluster/{cluster_id}/host/{host_id}/config/current/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

host > config > history > list

GET /api/v1/cluster/{cluster_id}/host/{host_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

host > config > history > create

POST /api/v1/cluster/{cluster_id}/host/{host_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
host_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
config required
attr

host > config > history > read

GET /api/v1/cluster/{cluster_id}/host/{host_id}/config/history/{version}/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
host_id required
version required

host > config > history > restore > partial_update

PATCH /api/v1/cluster/{cluster_id}/host/{host_id}/config/history/{version}/restore/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
host_id required
version required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
attr

host > config > previous > list

GET /api/v1/cluster/{cluster_id}/host/{host_id}/config/previous/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

hostcomponent > list

GET /api/v1/cluster/{cluster_id}/hostcomponent/

Show host <-> component map in a specified cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

hostcomponent > create

POST /api/v1/cluster/{cluster_id}/hostcomponent/

Create new mapping service:component <-> host in a specified cluster.

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
host_id required host id
service_id required
component required component name

hostcomponent > read

GET /api/v1/cluster/{cluster_id}/hostcomponent/{hs_id}/

Show host <-> component link in a specified cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
hs_id required

import > list

GET /api/v1/cluster/{cluster_id}/import/

List all imports available for specified cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

import > create

POST /api/v1/cluster/{cluster_id}/import/

Update bind for cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
min_strict
max_strict

service > list

GET /api/v1/cluster/{cluster_id}/service/

List all services

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
cluster_id
orderingWhich field to use when ordering the results.

service > create

POST /api/v1/cluster/{cluster_id}/service/

Add service to cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
cluster_id required
prototype_id required id of service prototype

service > read

GET /api/v1/cluster/{cluster_id}/service/{service_id}/

Show service

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required

service > delete

DELETE /api/v1/cluster/{cluster_id}/service/{service_id}/

Remove service from cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required

service > action > list

GET /api/v1/cluster/{cluster_id}/service/{service_id}/action/

List all actions of a specified object

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
button
button_is_null

service > action > read

GET /api/v1/cluster/{cluster_id}/service/{service_id}/action/{action_id}/

Show specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
action_id required

service > action > run > create

POST /api/v1/cluster/{cluster_id}/service/{service_id}/action/{action_id}/run/

Ran specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
action_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
config
attr
hc
hosts
verbose

service > bind > list

GET /api/v1/cluster/{cluster_id}/service/{service_id}/bind/

List all binds of service

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

service > bind > create

POST /api/v1/cluster/{cluster_id}/service/{service_id}/bind/

Bind two services

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required

service > bind > read

GET /api/v1/cluster/{cluster_id}/service/{service_id}/bind/{bind_id}/

Show specified bind of service

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
bind_id required

service > bind > delete

DELETE /api/v1/cluster/{cluster_id}/service/{service_id}/bind/{bind_id}/

Unbind specified bind of service

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
bind_id required

service > component > list

GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/

List all components

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
cluster_id
service_id
orderingWhich field to use when ordering the results.

service > component > read

GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/

Show component

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
component_id required

service > component > action > list

GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/action/

List all actions of a specified object

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
button
button_is_null

service > component > action > read

GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/action/{action_id}/

Show specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
component_id required
action_id required

service > component > action > run > create

POST /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/action/{action_id}/run/

Ran specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
component_id required
action_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
config
attr
hc
hosts
verbose

service > component > config > list

GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/config/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

service > component > config > current > list

GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/config/current/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

service > component > config > history > list

GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

service > component > config > history > create

POST /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
component_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
config required
attr

service > component > config > history > read

GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/config/history/{version}/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
component_id required
version required

service > component > config > history > restore > partial_update

PATCH /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/config/history/{version}/restore/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
component_id required
version required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
attr

service > component > config > previous > list

GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/config/previous/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

service > config > list

GET /api/v1/cluster/{cluster_id}/service/{service_id}/config/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

service > config > current > list

GET /api/v1/cluster/{cluster_id}/service/{service_id}/config/current/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

service > config > history > list

GET /api/v1/cluster/{cluster_id}/service/{service_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

service > config > history > create

POST /api/v1/cluster/{cluster_id}/service/{service_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
config required
attr

service > config > history > read

GET /api/v1/cluster/{cluster_id}/service/{service_id}/config/history/{version}/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
version required

service > config > history > restore > partial_update

PATCH /api/v1/cluster/{cluster_id}/service/{service_id}/config/history/{version}/restore/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required
version required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
attr

service > config > previous > list

GET /api/v1/cluster/{cluster_id}/service/{service_id}/config/previous/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

service > import > list

GET /api/v1/cluster/{cluster_id}/service/{service_id}/import/

List all imports available for specified service

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

service > import > create

POST /api/v1/cluster/{cluster_id}/service/{service_id}/import/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
service_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
min_strict
max_strict

serviceprototype > list

GET /api/v1/cluster/{cluster_id}/serviceprototype/

List all services of specified cluster of bundle

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

status > list

GET /api/v1/cluster/{cluster_id}/status/

Show all hosts and components in a specified cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

upgrade > list

GET /api/v1/cluster/{cluster_id}/upgrade/

List all available upgrades for specified cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
orderingWhich field to use when ordering the results.

upgrade > read

GET /api/v1/cluster/{cluster_id}/upgrade/{upgrade_id}/

List all available upgrades for specified cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
upgrade_id required

upgrade > do > create

POST /api/v1/cluster/{cluster_id}/upgrade/{upgrade_id}/do/

Do upgrade specified cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
cluster_id required
upgrade_id required

component

list

GET /api/v1/component/

List all components

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
cluster_id
service_id
orderingWhich field to use when ordering the results.

read

GET /api/v1/component/{component_id}/

Show component

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
component_id required

action > list

GET /api/v1/component/{component_id}/action/

List all actions of a specified object

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
button
button_is_null

action > read

GET /api/v1/component/{component_id}/action/{action_id}/

Show specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
component_id required
action_id required

action > run > create

POST /api/v1/component/{component_id}/action/{action_id}/run/

Ran specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
component_id required
action_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
config
attr
hc
hosts
verbose

config > list

GET /api/v1/component/{component_id}/config/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > current > list

GET /api/v1/component/{component_id}/config/current/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > history > list

GET /api/v1/component/{component_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > history > create

POST /api/v1/component/{component_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
component_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
config required
attr

config > history > read

GET /api/v1/component/{component_id}/config/history/{version}/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
component_id required
version required

config > history > restore > partial_update

PATCH /api/v1/component/{component_id}/config/history/{version}/restore/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
component_id required
version required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
attr

config > previous > list

GET /api/v1/component/{component_id}/config/previous/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

group

list

GET /api/v1/group/

List all existing user groups

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
orderingWhich field to use when ordering the results.

create

POST /api/v1/group/

Create new user group

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
name required

read

GET /api/v1/group/{name}/

show user group

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
name required

delete

DELETE /api/v1/group/{name}/

delete user group

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
name required

role > create

POST /api/v1/group/{name}/role/

Add group role

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
name required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
role_id required

role > delete

DELETE /api/v1/group/{name}/role/

Remove group role

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
name required

host

list

GET /api/v1/host/

List all hosts

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
cluster_id
prototype_id
provider_id
fqdn
cluster_is_null
provider_is_null
orderingWhich field to use when ordering the results.

create

POST /api/v1/host/

Create host

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
prototype_id required id of host type
provider_id required
fqdn required fully qualified domain name
description

read

GET /api/v1/host/{host_id}/

Show host

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
host_id required

delete

DELETE /api/v1/host/{host_id}/

Delete host

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
host_id required

action > list

GET /api/v1/host/{host_id}/action/

List all actions of a specified object

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
button
button_is_null

action > read

GET /api/v1/host/{host_id}/action/{action_id}/

Show specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
host_id required
action_id required

action > run > create

POST /api/v1/host/{host_id}/action/{action_id}/run/

Ran specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
host_id required
action_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
config
attr
hc
hosts
verbose

config > list

GET /api/v1/host/{host_id}/config/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > current > list

GET /api/v1/host/{host_id}/config/current/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > history > list

GET /api/v1/host/{host_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > history > create

POST /api/v1/host/{host_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
host_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
config required
attr

config > history > read

GET /api/v1/host/{host_id}/config/history/{version}/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
host_id required
version required

config > history > restore > partial_update

PATCH /api/v1/host/{host_id}/config/history/{version}/restore/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
host_id required
version required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
attr

config > previous > list

GET /api/v1/host/{host_id}/config/previous/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

info

list

GET /api/v1/info/

General info about ADCM

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

job

list

GET /api/v1/job/

List all jobs

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
action_id
task_id
pid
status
start_date
finish_date
orderingWhich field to use when ordering the results.

read

GET /api/v1/job/{job_id}/

Show job

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
job_id required

log > list

GET /api/v1/job/{job_id}/log/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
job_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
type
format
orderingWhich field to use when ordering the results.

log > read

GET /api/v1/job/{job_id}/log/{log_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
job_id required
log_id required

log > read_0

GET /api/v1/job/{job_id}/log/{tag}/{level}/{log_type}/

Show log file

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
job_id required
tag required
level required
log_type required

logout

create

POST /api/v1/logout/

Logout user from Django session

profile

list

GET /api/v1/profile/

List all existing user’s profiles

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
orderingWhich field to use when ordering the results.

create

POST /api/v1/profile/

Create new user profile

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
username required
profile required

read

GET /api/v1/profile/{username}/

Show user profile

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
username required

partial_update

PATCH /api/v1/profile/{username}/

Edit user profile

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
username required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
profile

delete

DELETE /api/v1/profile/{username}/

delete user and profile

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
username required

password > partial_update

PATCH /api/v1/profile/{username}/password/

Change user password

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
username required Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
password

provider

list

GET /api/v1/provider/

List all host providers

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
prototype_id
orderingWhich field to use when ordering the results.

create

POST /api/v1/provider/

Create new host provider

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
name required
prototype_id required
description

read

GET /api/v1/provider/{provider_id}/

Show host provider

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required

delete

DELETE /api/v1/provider/{provider_id}/

Remove host provider

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required

action > list

GET /api/v1/provider/{provider_id}/action/

List all actions of a specified object

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
button
button_is_null

action > read

GET /api/v1/provider/{provider_id}/action/{action_id}/

Show specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
action_id required

action > run > create

POST /api/v1/provider/{provider_id}/action/{action_id}/run/

Ran specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
action_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
config
attr
hc
hosts
verbose

config > list

GET /api/v1/provider/{provider_id}/config/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > current > list

GET /api/v1/provider/{provider_id}/config/current/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > history > list

GET /api/v1/provider/{provider_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > history > create

POST /api/v1/provider/{provider_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
config required
attr

config > history > read

GET /api/v1/provider/{provider_id}/config/history/{version}/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
version required

config > history > restore > partial_update

PATCH /api/v1/provider/{provider_id}/config/history/{version}/restore/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
version required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
attr

config > previous > list

GET /api/v1/provider/{provider_id}/config/previous/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

host > list

GET /api/v1/provider/{provider_id}/host/

List all hosts

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
cluster_id
prototype_id
provider_id
fqdn
cluster_is_null
provider_is_null
orderingWhich field to use when ordering the results.

host > create

POST /api/v1/provider/{provider_id}/host/

Create host

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
fqdn required fully qualified domain name
description

host > read

GET /api/v1/provider/{provider_id}/host/{host_id}/

Show host

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
host_id required

host > delete

DELETE /api/v1/provider/{provider_id}/host/{host_id}/

Delete host

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
host_id required

host > action > list

GET /api/v1/provider/{provider_id}/host/{host_id}/action/

List all actions of a specified object

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
button
button_is_null

host > action > read

GET /api/v1/provider/{provider_id}/host/{host_id}/action/{action_id}/

Show specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
host_id required
action_id required

host > action > run > create

POST /api/v1/provider/{provider_id}/host/{host_id}/action/{action_id}/run/

Ran specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
host_id required
action_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
config
attr
hc
hosts
verbose

host > config > list

GET /api/v1/provider/{provider_id}/host/{host_id}/config/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

host > config > current > list

GET /api/v1/provider/{provider_id}/host/{host_id}/config/current/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

host > config > history > list

GET /api/v1/provider/{provider_id}/host/{host_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

host > config > history > create

POST /api/v1/provider/{provider_id}/host/{host_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
host_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
config required
attr

host > config > history > read

GET /api/v1/provider/{provider_id}/host/{host_id}/config/history/{version}/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
host_id required
version required

host > config > history > restore > partial_update

PATCH /api/v1/provider/{provider_id}/host/{host_id}/config/history/{version}/restore/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
host_id required
version required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
attr

host > config > previous > list

GET /api/v1/provider/{provider_id}/host/{host_id}/config/previous/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
host_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

upgrade > list

GET /api/v1/provider/{provider_id}/upgrade/

List all available upgrades for specified host provider

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
orderingWhich field to use when ordering the results.

upgrade > read

GET /api/v1/provider/{provider_id}/upgrade/{upgrade_id}/

List all available upgrades for specified host provider

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
upgrade_id required

upgrade > do > create

POST /api/v1/provider/{provider_id}/upgrade/{upgrade_id}/do/

Do upgrade specified host provider

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
provider_id required
upgrade_id required

role

list

GET /api/v1/role/

List all existing roles

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
orderingWhich field to use when ordering the results.

read

GET /api/v1/role/{role_id}/

show role

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
role_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
orderingWhich field to use when ordering the results.

service

list

GET /api/v1/service/

List all services

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
cluster_id
orderingWhich field to use when ordering the results.

create

POST /api/v1/service/

Add service to cluster

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
cluster_id required
prototype_id required id of service prototype

read

GET /api/v1/service/{service_id}/

Show service

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required

delete

DELETE /api/v1/service/{service_id}/

Remove service from cluster

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required

action > list

GET /api/v1/service/{service_id}/action/

List all actions of a specified object

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
button
button_is_null

action > read

GET /api/v1/service/{service_id}/action/{action_id}/

Show specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
action_id required

action > run > create

POST /api/v1/service/{service_id}/action/{action_id}/run/

Ran specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
action_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
config
attr
hc
hosts
verbose

bind > list

GET /api/v1/service/{service_id}/bind/

List all binds of service

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

bind > create

POST /api/v1/service/{service_id}/bind/

Bind two services

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required

bind > read

GET /api/v1/service/{service_id}/bind/{bind_id}/

Show specified bind of service

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
bind_id required

bind > delete

DELETE /api/v1/service/{service_id}/bind/{bind_id}/

Unbind specified bind of service

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
bind_id required

component > list

GET /api/v1/service/{service_id}/component/

List all components

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
cluster_id
service_id
orderingWhich field to use when ordering the results.

component > read

GET /api/v1/service/{service_id}/component/{component_id}/

Show component

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
component_id required

component > action > list

GET /api/v1/service/{service_id}/component/{component_id}/action/

List all actions of a specified object

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
button
button_is_null

component > action > read

GET /api/v1/service/{service_id}/component/{component_id}/action/{action_id}/

Show specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
component_id required
action_id required

component > action > run > create

POST /api/v1/service/{service_id}/component/{component_id}/action/{action_id}/run/

Ran specified action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
component_id required
action_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
config
attr
hc
hosts
verbose

component > config > list

GET /api/v1/service/{service_id}/component/{component_id}/config/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

component > config > current > list

GET /api/v1/service/{service_id}/component/{component_id}/config/current/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

component > config > history > list

GET /api/v1/service/{service_id}/component/{component_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

component > config > history > create

POST /api/v1/service/{service_id}/component/{component_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
component_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
config required
attr

component > config > history > read

GET /api/v1/service/{service_id}/component/{component_id}/config/history/{version}/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
component_id required
version required

component > config > history > restore > partial_update

PATCH /api/v1/service/{service_id}/component/{component_id}/config/history/{version}/restore/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
component_id required
version required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
attr

component > config > previous > list

GET /api/v1/service/{service_id}/component/{component_id}/config/previous/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
component_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > list

GET /api/v1/service/{service_id}/config/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > current > list

GET /api/v1/service/{service_id}/config/current/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > history > list

GET /api/v1/service/{service_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

config > history > create

POST /api/v1/service/{service_id}/config/history/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
config required
attr

config > history > read

GET /api/v1/service/{service_id}/config/history/{version}/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
version required

config > history > restore > partial_update

PATCH /api/v1/service/{service_id}/config/history/{version}/restore/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required
version required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description
attr

config > previous > list

GET /api/v1/service/{service_id}/config/previous/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

import > list

GET /api/v1/service/{service_id}/import/

List all imports available for specified service

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

import > create

POST /api/v1/service/{service_id}/import/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
service_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
min_strict
max_strict

stack

list

GET /api/v1/stack/

Operations with stack of services

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

action > read

GET /api/v1/stack/action/{action_id}/

Show action

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
action_id required

adcm > list

GET /api/v1/stack/adcm/

List adcm root object prototypes

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
bundle_id

adcm > read

GET /api/v1/stack/adcm/{prototype_id}/

Show adcm prototype

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
prototype_id required

bundle > list

GET /api/v1/stack/bundle/

List all bundles

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
version
orderingWhich field to use when ordering the results.

bundle > read

GET /api/v1/stack/bundle/{bundle_id}/

Show bundle

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
bundle_id required

bundle > delete

DELETE /api/v1/stack/bundle/{bundle_id}/

Remove bundle

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
bundle_id required

bundle > license > read

GET /api/v1/stack/bundle/{bundle_id}/license/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
bundle_id required

bundle > license > accept > update

PUT /api/v1/stack/bundle/{bundle_id}/license/accept/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
bundle_id required

bundle > update > update

PUT /api/v1/stack/bundle/{bundle_id}/update/

update bundle

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
bundle_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
description

cluster > list

GET /api/v1/stack/cluster/

List all cluster types

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
bundle_id
display_name
orderingWhich field to use when ordering the results.

cluster > read

GET /api/v1/stack/cluster/{prototype_id}/

Show cluster prototype

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
prototype_id required

component > list

GET /api/v1/stack/component/

List all stack components

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
bundle_id
orderingWhich field to use when ordering the results.

component > read

GET /api/v1/stack/component/{prototype_id}/

Show component prototype

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
prototype_id required

host > list

GET /api/v1/stack/host/

List all host types

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
bundle_id
orderingWhich field to use when ordering the results.

host > read

GET /api/v1/stack/host/{prototype_id}/

Show host prototype

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
prototype_id required

load > create

POST /api/v1/stack/load/

Load bundle

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
bundle_file required

load > servicemap > update

PUT /api/v1/stack/load/servicemap/

prototype > list

GET /api/v1/stack/prototype/

List all stack prototypes

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
bundle_id
type
orderingWhich field to use when ordering the results.

prototype > read

GET /api/v1/stack/prototype/{prototype_id}/

Show prototype

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
prototype_id required

provider > list

GET /api/v1/stack/provider/

List all host providers types

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
bundle_id
display_name
orderingWhich field to use when ordering the results.

provider > read

GET /api/v1/stack/provider/{prototype_id}/

Show host provider prototype

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
prototype_id required

service > list

GET /api/v1/stack/service/

List all stack services

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
name
bundle_id
orderingWhich field to use when ordering the results.

service > read

GET /api/v1/stack/service/{prototype_id}/

Show stack service

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
prototype_id required

service > action > list

GET /api/v1/stack/service/{prototype_id}/action/

List all actions of a specified service

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
prototype_id required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

upload > create

POST /api/v1/stack/upload/

Request Body

The request body should be a “multipart/form-data” encoded object, containing the following items.

Parameter Description
file required bundle file for upload

stats

list

GET /api/v1/stats/

Statistics

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.

job > read

GET /api/v1/stats/job/{job_id}/

Show jobs stats

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
job_id required

task > read

GET /api/v1/stats/task/{task_id}/

Show tasks stats

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
task_id required

swagger

list

GET /api/v1/swagger/

task

list

GET /api/v1/task/

List all tasks

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
action_id
pid
status
start_date
finish_date
orderingWhich field to use when ordering the results.

create

POST /api/v1/task/

Create and run new task Return handler to new task

read

GET /api/v1/task/{task_id}/

Show task

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
task_id required

cancel > update

PUT /api/v1/task/{task_id}/cancel/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
task_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
config
attr
hc
hosts
verbose

restart > update

PUT /api/v1/task/{task_id}/restart/

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
task_id required

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
config
attr
hc
hosts
verbose

token

create

POST /api/v1/token/

Provide authentication token

HTTP header for authorization:

Authorization: Token XXXXX

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
username required
password required

user

list

GET /api/v1/user/

List all existing users

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
orderingWhich field to use when ordering the results.

create

POST /api/v1/user/

Create new user

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
username required
password required
is_superuser

read

GET /api/v1/user/{username}/

show user

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
username required Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

delete

DELETE /api/v1/user/{username}/

delete user and profile

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
username required Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

group > create

POST /api/v1/user/{username}/group/

Add user to group

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
username required Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
name required

group > delete

DELETE /api/v1/user/{username}/group/

Remove user from group

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
username required Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

password > partial_update

PATCH /api/v1/user/{username}/password/

Change user password

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
username required Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
password

role > create

POST /api/v1/user/{username}/role/

Add user role

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
username required Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Request Body

The request body should be a “application/json” encoded object, containing the following items.

Parameter Description
role_id required

role > delete

DELETE /api/v1/user/{username}/role/

Remove user role

Path Parameters

The following parameters should be included in the URL path.

Parameter Description
username required Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.