ArenaData Cluster Manager API¶
Version: 1.0
Intro¶
Cluster: Set of hosts and services
Host: Abstract container for components
Service: Set of components
Component: Peace 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
API Sections¶
adcm¶
list¶
GET /api/v1/adcm/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
read¶
GET /api/v1/adcm/{adcm_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
adcm_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
action > list¶
GET /api/v1/adcm/{adcm_pk}/action/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
adcm_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
action > read¶
GET /api/v1/adcm/{adcm_pk}/action/{action_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
adcm_pk required |
|
action_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
action > run > create¶
POST /api/v1/adcm/{adcm_pk}/action/{action_id}/run/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
adcm_pk required |
|
action_id required |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
config |
|
attr |
|
hosts |
|
verbose |
|
hc |
config > list¶
GET /api/v1/adcm/{adcm_pk}/config/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
adcm_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
config > current > list¶
GET /api/v1/adcm/{adcm_pk}/config/current/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
adcm_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
config > history > list¶
GET /api/v1/adcm/{adcm_pk}/config/history/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
adcm_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
config > history > create¶
POST /api/v1/adcm/{adcm_pk}/config/history/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
adcm_pk 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_pk}/config/history/{version}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
adcm_pk required |
|
version required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
config > history > restore > partial_update¶
PATCH /api/v1/adcm/{adcm_pk}/config/history/{version}/restore/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
adcm_pk required |
|
version required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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_pk}/config/previous/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
adcm_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
audit¶
login > list¶
GET /api/v1/audit/login/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
login_result | |
username | |
login_date | |
login_time | |
ordering | Which field to use when ordering the results. |
search | A search term. |
login > read¶
GET /api/v1/audit/login/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this audit session. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
login_result | |
username | |
login_date | |
login_time | |
ordering | Which field to use when ordering the results. |
search | A search term. |
operation > list¶
GET /api/v1/audit/operation/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
operation_type | |
operation_name | |
operation_result | |
object_type | |
object_name | |
operation_date | |
username | |
operation_time | |
ordering | Which field to use when ordering the results. |
search | A search term. |
operation > read¶
GET /api/v1/audit/operation/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this audit log. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
operation_type | |
operation_name | |
operation_result | |
object_type | |
object_name | |
operation_date | |
username | |
operation_time | |
ordering | Which field to use when ordering the results. |
search | A search term. |
cluster¶
list¶
GET /api/v1/cluster/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
create¶
POST /api/v1/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}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update¶
PUT /api/v1/cluster/{cluster_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
partial_update¶
PATCH /api/v1/cluster/{cluster_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
action > list¶
GET /api/v1/cluster/{cluster_id}/action/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
action > read¶
GET /api/v1/cluster/{cluster_id}/action/{action_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
cluster_id required |
|
action_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
action > run > create¶
POST /api/v1/cluster/{cluster_id}/action/{action_id}/run/
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 |
|
hosts |
|
verbose |
|
hc |
bind > list¶
GET /api/v1/cluster/{cluster_id}/bind/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
bind > create¶
POST /api/v1/cluster/{cluster_id}/bind/
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}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
cluster_id required |
|
bind_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
bind > delete¶
DELETE /api/v1/cluster/{cluster_id}/bind/{bind_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
cluster_id required |
|
bind_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
host > list¶
GET /api/v1/cluster/{cluster_id}/host/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
cluster_id | |
prototype_id | |
provider_id | |
fqdn | |
cluster_is_null | |
provider_is_null | |
group_config | |
hostcomponent__service_id | |
hostcomponent__component_id | |
exclude_group_config__in | Multiple values may be separated by commas. |
ordering | Which field to use when ordering the results. |
host > create¶
POST /api/v1/cluster/{cluster_id}/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}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
host > update¶
PUT /api/v1/cluster/{cluster_id}/host/{host_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
host > partial_update¶
PATCH /api/v1/cluster/{cluster_id}/host/{host_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
prototype_id |
id of host type |
provider_id |
|
fqdn |
fully qualified domain name |
description |
host > delete¶
DELETE /api/v1/cluster/{cluster_id}/host/{host_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
host > action > list¶
GET /api/v1/cluster/{cluster_id}/host/{host_id}/action/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
host > action > read¶
GET /api/v1/cluster/{cluster_id}/host/{host_id}/action/{action_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
cluster_id required |
|
host_id required |
|
action_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
host > action > run > create¶
POST /api/v1/cluster/{cluster_id}/host/{host_id}/action/{action_id}/run/
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 |
|
hosts |
|
verbose |
|
hc |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
host > maintenance-mode > create¶
POST /api/v1/cluster/{cluster_id}/host/{host_id}/maintenance-mode/
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 |
|---|---|
maintenance_mode required |
host > status > list¶
GET /api/v1/cluster/{cluster_id}/host/{host_id}/status/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
hostcomponent > list¶
GET /api/v1/cluster/{cluster_id}/hostcomponent/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
hostcomponent > create¶
POST /api/v1/cluster/{cluster_id}/hostcomponent/
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}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
cluster_id required |
|
hs_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
import > list¶
GET /api/v1/cluster/{cluster_id}/import/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
import > create¶
POST /api/v1/cluster/{cluster_id}/import/
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/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
service > create¶
POST /api/v1/cluster/{cluster_id}/service/
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}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
service > delete¶
DELETE /api/v1/cluster/{cluster_id}/service/{service_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
service > action > list¶
GET /api/v1/cluster/{cluster_id}/service/{service_id}/action/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
service > action > read¶
GET /api/v1/cluster/{cluster_id}/service/{service_id}/action/{action_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
cluster_id required |
|
service_id required |
|
action_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
service > action > run > create¶
POST /api/v1/cluster/{cluster_id}/service/{service_id}/action/{action_id}/run/
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 |
|
hosts |
|
verbose |
|
hc |
service > bind > list¶
GET /api/v1/cluster/{cluster_id}/service/{service_id}/bind/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
service > bind > create¶
POST /api/v1/cluster/{cluster_id}/service/{service_id}/bind/
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}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
cluster_id required |
|
service_id required |
|
bind_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
service > bind > delete¶
DELETE /api/v1/cluster/{cluster_id}/service/{service_id}/bind/{bind_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
cluster_id required |
|
service_id required |
|
bind_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
service > component > list¶
GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
service > component > read¶
GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
service > component > action > list¶
GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/action/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
service > component > action > read¶
GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/action/{action_id}/
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
service > component > action > run > create¶
POST /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/action/{action_id}/run/
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 |
|
hosts |
|
verbose |
|
hc |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
service > component > maintenance-mode > create¶
POST /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/maintenance-mode/
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 |
|---|---|
maintenance_mode required |
service > component > status > list¶
GET /api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/status/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
service > import > list¶
GET /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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
service > maintenance-mode > create¶
POST /api/v1/cluster/{cluster_id}/service/{service_id}/maintenance-mode/
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 |
|---|---|
maintenance_mode required |
service > status > list¶
GET /api/v1/cluster/{cluster_id}/service/{service_id}/status/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
serviceprototype > list¶
GET /api/v1/cluster/{cluster_id}/serviceprototype/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
status > list¶
GET /api/v1/cluster/{cluster_id}/status/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
upgrade > list¶
GET /api/v1/cluster/{cluster_id}/upgrade/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
upgrade > read¶
GET /api/v1/cluster/{cluster_id}/upgrade/{upgrade_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
cluster_id required |
|
upgrade_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
upgrade > do > create¶
POST /api/v1/cluster/{cluster_id}/upgrade/{upgrade_id}/do/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
cluster_id required |
|
upgrade_id required |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
config |
|
attr |
|
hc |
component¶
list¶
GET /api/v1/component/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
read¶
GET /api/v1/component/{component_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
action > list¶
GET /api/v1/component/{component_id}/action/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
action > read¶
GET /api/v1/component/{component_id}/action/{action_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
component_id required |
|
action_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
action > run > create¶
POST /api/v1/component/{component_id}/action/{action_id}/run/
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 |
|
hosts |
|
verbose |
|
hc |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
maintenance-mode > create¶
POST /api/v1/component/{component_id}/maintenance-mode/
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 |
|---|---|
maintenance_mode required |
status > list¶
GET /api/v1/component/{component_id}/status/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
concern¶
list¶
GET /api/v1/concern/
List of all existing concern items
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
name | |
type | |
cause | |
object_type | |
object_id | |
owner_type | |
owner_id | |
ordering | Which field to use when ordering the results. |
read¶
GET /api/v1/concern/{concern_id}/
Show concern item
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
concern_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
config¶
list¶
GET /api/v1/config/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
read¶
GET /api/v1/config/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this object config. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
config-log¶
list¶
GET /api/v1/config-log/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create¶
POST /api/v1/config-log/
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
obj_ref required |
|
description |
|
config required |
|
attr |
read¶
GET /api/v1/config-log/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this config log. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
group-config¶
list¶
GET /api/v1/group-config/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
object_id | |
object_type | |
ordering | Which field to use when ordering the results. |
search | A search term. |
create¶
POST /api/v1/group-config/
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
object_id required |
|
object_type required |
|
name required |
|
description |
read¶
GET /api/v1/group-config/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this group config. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
object_id | |
object_type | |
ordering | Which field to use when ordering the results. |
search | A search term. |
update¶
PUT /api/v1/group-config/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this group config. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
object_id | |
object_type | |
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
object_id required |
|
object_type required |
|
name required |
|
description |
partial_update¶
PATCH /api/v1/group-config/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this group config. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
object_id | |
object_type | |
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
object_id |
|
object_type |
|
name |
|
description |
delete¶
DELETE /api/v1/group-config/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this group config. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
object_id | |
object_type | |
ordering | Which field to use when ordering the results. |
search | A search term. |
config > read¶
GET /api/v1/group-config/{parent_lookup_group_config}/config/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
parent_lookup_group_config required |
|
id required |
A unique integer value identifying this object config. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
config > config-log > list¶
GET /api/v1/group-config/{parent_lookup_obj_ref__group_config}/config/{parent_lookup_obj_ref}/config-log/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
parent_lookup_obj_ref__group_config required |
|
parent_lookup_obj_ref required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
ordering | Which field to use when ordering the results. |
search | A search term. |
config > config-log > create¶
POST /api/v1/group-config/{parent_lookup_obj_ref__group_config}/config/{parent_lookup_obj_ref}/config-log/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
parent_lookup_obj_ref__group_config required |
|
parent_lookup_obj_ref required |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
description |
|
config required |
|
attr |
config > config-log > read¶
GET /api/v1/group-config/{parent_lookup_obj_ref__group_config}/config/{parent_lookup_obj_ref}/config-log/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
parent_lookup_obj_ref__group_config required |
|
parent_lookup_obj_ref required |
|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
ordering | Which field to use when ordering the results. |
search | A search term. |
host > list¶
GET /api/v1/group-config/{parent_lookup_group_config}/host/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
parent_lookup_group_config required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
host > create¶
POST /api/v1/group-config/{parent_lookup_group_config}/host/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
parent_lookup_group_config required |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
id required |
host > read¶
GET /api/v1/group-config/{parent_lookup_group_config}/host/{host_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
parent_lookup_group_config required |
|
host_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
host > delete¶
DELETE /api/v1/group-config/{parent_lookup_group_config}/host/{host_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
parent_lookup_group_config required |
|
host_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
host-candidate > list¶
GET /api/v1/group-config/{parent_lookup_group_config}/host-candidate/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
parent_lookup_group_config required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
host-candidate > read¶
GET /api/v1/group-config/{parent_lookup_group_config}/host-candidate/{host_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
parent_lookup_group_config required |
|
host_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
host¶
list¶
GET /api/v1/host/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
cluster_id | |
prototype_id | |
provider_id | |
fqdn | |
cluster_is_null | |
provider_is_null | |
group_config | |
hostcomponent__service_id | |
hostcomponent__component_id | |
exclude_group_config__in | Multiple values may be separated by commas. |
ordering | Which field to use when ordering the results. |
create¶
POST /api/v1/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}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update¶
PUT /api/v1/host/{host_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
partial_update¶
PATCH /api/v1/host/{host_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
prototype_id |
id of host type |
provider_id |
|
fqdn |
fully qualified domain name |
description |
delete¶
DELETE /api/v1/host/{host_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
action > list¶
GET /api/v1/host/{host_id}/action/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
action > read¶
GET /api/v1/host/{host_id}/action/{action_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
host_id required |
|
action_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
action > run > create¶
POST /api/v1/host/{host_id}/action/{action_id}/run/
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 |
|
hosts |
|
verbose |
|
hc |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
maintenance-mode > create¶
POST /api/v1/host/{host_id}/maintenance-mode/
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 |
|---|---|
maintenance_mode required |
status > list¶
GET /api/v1/host/{host_id}/status/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
job¶
list¶
GET /api/v1/job/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
read¶
GET /api/v1/job/{job_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
job_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
cancel¶
PUT /api/v1/job/{job_pk}/cancel/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
job_pk required |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
pid |
|
status required |
|
start_date required |
|
finish_date required |
|
action required |
|
selector required |
log > list¶
GET /api/v1/job/{job_pk}/log/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
job_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
log > read¶
GET /api/v1/job/{job_pk}/log/{log_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
job_pk required |
|
log_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
log > download¶
GET /api/v1/job/{job_pk}/log/{log_pk}/download/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
job_pk required |
|
log_pk required |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which 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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
action > list¶
GET /api/v1/provider/{provider_id}/action/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
action > read¶
GET /api/v1/provider/{provider_id}/action/{action_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
provider_id required |
|
action_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
action > run > create¶
POST /api/v1/provider/{provider_id}/action/{action_id}/run/
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 |
|
hosts |
|
verbose |
|
hc |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
host > list¶
GET /api/v1/provider/{provider_id}/host/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
cluster_id | |
prototype_id | |
provider_id | |
fqdn | |
cluster_is_null | |
provider_is_null | |
group_config | |
hostcomponent__service_id | |
hostcomponent__component_id | |
exclude_group_config__in | Multiple values may be separated by commas. |
ordering | Which field to use when ordering the results. |
host > create¶
POST /api/v1/provider/{provider_id}/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}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
host > update¶
PUT /api/v1/provider/{provider_id}/host/{host_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
host > partial_update¶
PATCH /api/v1/provider/{provider_id}/host/{host_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
prototype_id |
id of host type |
provider_id |
|
fqdn |
fully qualified domain name |
description |
host > delete¶
DELETE /api/v1/provider/{provider_id}/host/{host_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
host > action > list¶
GET /api/v1/provider/{provider_id}/host/{host_id}/action/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
host > action > read¶
GET /api/v1/provider/{provider_id}/host/{host_id}/action/{action_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
provider_id required |
|
host_id required |
|
action_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
host > action > run > create¶
POST /api/v1/provider/{provider_id}/host/{host_id}/action/{action_id}/run/
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 |
|
hosts |
|
verbose |
|
hc |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
host > maintenance-mode > create¶
POST /api/v1/provider/{provider_id}/host/{host_id}/maintenance-mode/
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 |
|---|---|
maintenance_mode required |
host > status > list¶
GET /api/v1/provider/{provider_id}/host/{host_id}/status/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which 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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
upgrade > do > create¶
POST /api/v1/provider/{provider_id}/upgrade/{upgrade_id}/do/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
provider_id required |
|
upgrade_id required |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
config |
|
attr |
rbac¶
group > list¶
GET /api/v1/rbac/group/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
type | |
name | |
ordering | Which field to use when ordering the results. |
group > create¶
POST /api/v1/rbac/group/
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required |
|
description |
|
user |
group > read¶
GET /api/v1/rbac/group/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this group. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
type | |
name | |
ordering | Which field to use when ordering the results. |
group > update¶
PUT /api/v1/rbac/group/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this group. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
type | |
name | |
ordering | Which field to use when ordering the results. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required |
|
description |
|
user |
group > partial_update¶
PATCH /api/v1/rbac/group/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this group. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
type | |
name | |
ordering | Which field to use when ordering the results. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
name |
|
description |
|
user |
group > delete¶
DELETE /api/v1/rbac/group/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this group. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
type | |
name | |
ordering | Which field to use when ordering the results. |
logout > create¶
POST /api/v1/rbac/logout/
me > read¶
GET /api/v1/rbac/me/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
me > update¶
PUT /api/v1/rbac/me/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
password |
|
current_password |
|
profile |
me > partial_update¶
PATCH /api/v1/rbac/me/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
password |
|
current_password |
|
profile |
policy > list¶
GET /api/v1/rbac/policy/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
policy > create¶
POST /api/v1/rbac/policy/
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required |
|
description |
|
object required |
|
role required |
|
group required |
policy > read¶
GET /api/v1/rbac/policy/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this policy. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
policy > update¶
PUT /api/v1/rbac/policy/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this policy. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required |
|
description |
|
object required |
|
role required |
|
group required |
policy > partial_update¶
PATCH /api/v1/rbac/policy/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this policy. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
name |
|
description |
|
object |
|
role |
|
group |
policy > delete¶
DELETE /api/v1/rbac/policy/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this policy. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
role > list¶
GET /api/v1/rbac/role/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
display_name | |
built_in | |
type | |
child | |
category | |
ordering | Which field to use when ordering the results. |
search | A search term. |
role > create¶
POST /api/v1/rbac/role/
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
name |
|
description |
|
display_name required |
|
child required |
role > category¶
GET /api/v1/rbac/role/category/
role > read¶
GET /api/v1/rbac/role/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
name | |
display_name | |
built_in | |
type | |
child | |
category | |
ordering | Which field to use when ordering the results. |
search | A search term. |
role > update¶
PUT /api/v1/rbac/role/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
name | |
display_name | |
built_in | |
type | |
child | |
category | |
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
name |
|
description |
|
display_name required |
|
child required |
role > partial_update¶
PATCH /api/v1/rbac/role/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
name | |
display_name | |
built_in | |
type | |
child | |
category | |
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
name |
|
description |
|
display_name |
|
child |
role > delete¶
DELETE /api/v1/rbac/role/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
name | |
display_name | |
built_in | |
type | |
child | |
category | |
ordering | Which field to use when ordering the results. |
search | A search term. |
token > create¶
POST /api/v1/rbac/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/rbac/user/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
user > create¶
POST /api/v1/rbac/user/
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
username required |
|
first_name |
|
last_name |
|
email |
|
is_superuser |
|
password required |
|
current_password |
|
profile |
|
group |
|
is_active |
user > read¶
GET /api/v1/rbac/user/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this user. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
user > update¶
PUT /api/v1/rbac/user/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this user. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
username required |
|
first_name |
|
last_name |
|
email |
|
is_superuser |
|
password required |
|
current_password |
|
profile |
|
group |
|
is_active |
user > partial_update¶
PATCH /api/v1/rbac/user/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this user. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
username |
|
first_name |
|
last_name |
|
email |
|
is_superuser |
|
password |
|
current_password |
|
profile |
|
group |
|
is_active |
user > delete¶
DELETE /api/v1/rbac/user/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this user. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
user > reset_failed_login_attempts¶
POST /api/v1/rbac/user/{id}/reset_failed_login_attempts/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this user. |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
username required |
|
first_name |
|
last_name |
|
email |
|
is_superuser |
|
password required |
|
current_password |
|
profile |
|
group |
|
is_active |
service¶
list¶
GET /api/v1/service/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
create¶
POST /api/v1/service/
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}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
delete¶
DELETE /api/v1/service/{service_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
action > list¶
GET /api/v1/service/{service_id}/action/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
action > read¶
GET /api/v1/service/{service_id}/action/{action_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
service_id required |
|
action_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
action > run > create¶
POST /api/v1/service/{service_id}/action/{action_id}/run/
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 |
|
hosts |
|
verbose |
|
hc |
bind > list¶
GET /api/v1/service/{service_id}/bind/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
bind > create¶
POST /api/v1/service/{service_id}/bind/
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}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
service_id required |
|
bind_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
bind > delete¶
DELETE /api/v1/service/{service_id}/bind/{bind_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
service_id required |
|
bind_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
component > list¶
GET /api/v1/service/{service_id}/component/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
component > read¶
GET /api/v1/service/{service_id}/component/{component_id}/
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.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
component > action > list¶
GET /api/v1/service/{service_id}/component/{component_id}/action/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
component > action > read¶
GET /api/v1/service/{service_id}/component/{component_id}/action/{action_id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
service_id required |
|
component_id required |
|
action_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
component > action > run > create¶
POST /api/v1/service/{service_id}/component/{component_id}/action/{action_id}/run/
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 |
|
hosts |
|
verbose |
|
hc |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
component > maintenance-mode > create¶
POST /api/v1/service/{service_id}/component/{component_id}/maintenance-mode/
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 |
|---|---|
maintenance_mode required |
component > status > list¶
GET /api/v1/service/{service_id}/component/{component_id}/status/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
import > list¶
GET /api/v1/service/{service_id}/import/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
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 |
maintenance-mode > create¶
POST /api/v1/service/{service_id}/maintenance-mode/
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 |
|---|---|
maintenance_mode required |
status > list¶
GET /api/v1/service/{service_id}/status/
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.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
stack¶
action > read¶
GET /api/v1/stack/action/{action_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
action_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
adcm > list¶
GET /api/v1/stack/adcm/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
bundle_id | |
ordering | Which field to use when ordering the results. |
search | A search term. |
adcm > read¶
GET /api/v1/stack/adcm/{prototype_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
prototype_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
bundle_id | |
ordering | Which field to use when ordering the results. |
search | A search term. |
bundle > list¶
GET /api/v1/stack/bundle/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
name | |
version | |
ordering | Which field to use when ordering the results. |
search | A search term. |
bundle > create¶
POST /api/v1/stack/bundle/
bundle > read¶
GET /api/v1/stack/bundle/{bundle_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
bundle_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
name | |
version | |
ordering | Which field to use when ordering the results. |
search | A search term. |
bundle > update¶
PUT /api/v1/stack/bundle/{bundle_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
bundle_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
name | |
version | |
ordering | Which field to use when ordering the results. |
search | A search term. |
bundle > partial_update¶
PATCH /api/v1/stack/bundle/{bundle_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
bundle_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
name | |
version | |
ordering | Which field to use when ordering the results. |
search | A search term. |
bundle > delete¶
DELETE /api/v1/stack/bundle/{bundle_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
bundle_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
name | |
version | |
ordering | Which field to use when ordering the results. |
search | A search term. |
bundle > accept_license¶
PUT /api/v1/stack/bundle/{bundle_pk}/accept_license/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
bundle_pk required |
bundle > license_0¶
GET /api/v1/stack/bundle/{bundle_pk}/license/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
bundle_pk required |
bundle > update_bundle¶
PUT /api/v1/stack/bundle/{bundle_pk}/update/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
bundle_pk required |
bundle > update_bundle_0¶
PUT /api/v1/stack/bundle/{bundle_pk}/update_bundle/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
bundle_pk required |
bundle > license > accept_license¶
PUT /api/v1/stack/bundle/{bundle_pk}/license/accept/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
bundle_pk required |
cluster > list¶
GET /api/v1/stack/cluster/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
name | |
bundle_id | |
display_name | |
ordering | Which field to use when ordering the results. |
search | A search term. |
cluster > read¶
GET /api/v1/stack/cluster/{prototype_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
prototype_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
name | |
bundle_id | |
display_name | |
ordering | Which field to use when ordering the results. |
search | A search term. |
component > list¶
GET /api/v1/stack/component/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
name | |
bundle_id | |
ordering | Which field to use when ordering the results. |
search | A search term. |
component > read¶
GET /api/v1/stack/component/{prototype_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
prototype_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
name | |
bundle_id | |
ordering | Which field to use when ordering the results. |
search | A search term. |
host > list¶
GET /api/v1/stack/host/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
name | |
bundle_id | |
ordering | Which field to use when ordering the results. |
search | A search term. |
host > read¶
GET /api/v1/stack/host/{prototype_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
prototype_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
name | |
bundle_id | |
ordering | Which field to use when ordering the results. |
search | A search term. |
load > create¶
POST /api/v1/stack/load/
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
bundle_file required |
prototype > list¶
GET /api/v1/stack/prototype/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
name | |
bundle_id | |
license | |
ordering | Which field to use when ordering the results. |
search | A search term. |
prototype > read¶
GET /api/v1/stack/prototype/{prototype_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
prototype_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
name | |
bundle_id | |
license | |
ordering | Which field to use when ordering the results. |
search | A search term. |
prototype > accept_license¶
PUT /api/v1/stack/prototype/{prototype_pk}/accept_license/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
prototype_pk required |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
bundle_edition required |
prototype > license_0¶
GET /api/v1/stack/prototype/{prototype_pk}/license/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
prototype_pk required |
prototype > license > accept_license¶
PUT /api/v1/stack/prototype/{prototype_pk}/license/accept/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
prototype_pk required |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
bundle_edition required |
provider > list¶
GET /api/v1/stack/provider/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
name | |
bundle_id | |
ordering | Which field to use when ordering the results. |
search | A search term. |
provider > read¶
GET /api/v1/stack/provider/{prototype_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
prototype_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
name | |
bundle_id | |
ordering | Which field to use when ordering the results. |
search | A search term. |
service > list¶
GET /api/v1/stack/service/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
name | |
bundle_id | |
license | |
ordering | Which field to use when ordering the results. |
search | A search term. |
service > read¶
GET /api/v1/stack/service/{prototype_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
prototype_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
name | |
bundle_id | |
license | |
ordering | Which field to use when ordering the results. |
search | A search term. |
service > actions¶
GET /api/v1/stack/service/{prototype_pk}/actions/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
prototype_pk required |
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¶
job > read¶
GET /api/v1/stats/job/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this job log. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
task > read¶
GET /api/v1/stats/task/{id}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
A unique integer value identifying this task log. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
task¶
list¶
GET /api/v1/task/
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
ordering | Which field to use when ordering the results. |
search | A search term. |
read¶
GET /api/v1/task/{task_pk}/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
task_pk required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
cancel¶
PUT /api/v1/task/{task_pk}/cancel/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
task_pk required |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
config |
|
attr |
|
hosts |
|
verbose |
|
hc |
download¶
GET /api/v1/task/{task_pk}/download/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
task_pk required |
restart¶
PUT /api/v1/task/{task_pk}/restart/
Path Parameters¶
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
task_pk required |
Request Body¶
The request body should be a “application/json” encoded object, containing the following items.
| Parameter | Description |
|---|---|
config |
|
attr |
|
hosts |
|
verbose |
|
hc |