Marketplace Robot Accounts
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-robot-accounts/ |
List Marketplace Robot Accounts |
| GET | /api/marketplace-robot-accounts/{uuid}/ |
Retrieve |
| POST | /api/marketplace-robot-accounts/ |
Create |
| PUT | /api/marketplace-robot-accounts/{uuid}/ |
Update |
| PATCH | /api/marketplace-robot-accounts/{uuid}/ |
Partial Update |
| DELETE | /api/marketplace-robot-accounts/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/marketplace-robot-accounts/{uuid}/set_state_creating/ |
Set state creating |
| POST | /api/marketplace-robot-accounts/{uuid}/set_state_deleted/ |
Set state deleted |
| POST | /api/marketplace-robot-accounts/{uuid}/set_state_erred/ |
Set state erred |
| POST | /api/marketplace-robot-accounts/{uuid}/set_state_ok/ |
Set state ok |
| POST | /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/ |
Set state request deletion |
Core CRUD
List Marketplace Robot Accounts
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_robot_accounts_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created |
string (date-time) | Created after |
customer_uuid |
string (uuid) | |
field |
array | |
modified |
string (date-time) | Modified after |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | |
provider_uuid |
string (uuid) | |
resource |
string | |
resource_uuid |
string (uuid) | |
state |
integer | Enum: 1, 2, 3, 4, 5, 6 |
type |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | |
fingerprints.sha256 |
string | |
fingerprints.sha512 |
string | |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_robot_accounts_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | |
fingerprints.sha256 |
string | |
fingerprints.sha512 |
string | |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RobotAccountRequest - API Source:
marketplace_robot_accounts_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ||
description |
string | ||
resource |
string (uri) | ✓ | |
type |
string | ✓ | Type of the robot account. |
users |
array of string (uri)s | Users who have access to this robot account. | |
keys |
any | ||
responsible_user |
string (uri) |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of string (uri)s | Users who have access to this robot account. |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | |
fingerprints.sha256 |
string | |
fingerprints.sha512 |
string | |
responsible_user |
string (uri) |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RobotAccountRequest - API Source:
marketplace_robot_accounts_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ||
description |
string | ||
resource |
string (uri) | ✓ | |
type |
string | ✓ | Type of the robot account. |
users |
array of string (uri)s | Users who have access to this robot account. | |
keys |
any | ||
responsible_user |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of string (uri)s | Users who have access to this robot account. |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | |
fingerprints.sha256 |
string | |
fingerprints.sha512 |
string | |
responsible_user |
string (uri) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRobotAccountRequest - API Source:
marketplace_robot_accounts_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ||
description |
string | ||
resource |
string (uri) | ||
type |
string | Type of the robot account. | |
users |
array of string (uri)s | Users who have access to this robot account. | |
keys |
any | ||
responsible_user |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of string (uri)s | Users who have access to this robot account. |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | |
fingerprints.sha256 |
string | |
fingerprints.sha512 |
string | |
responsible_user |
string (uri) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_robot_accounts_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Set state creating
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_robot_accounts_set_state_creating
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | |
fingerprints.sha256 |
string | |
fingerprints.sha512 |
string | |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |
400 -
| Field | Type | Description |
|---|---|---|
detail |
string | Error message to be displayed to the user |
Set state deleted
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_robot_accounts_set_state_deleted
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | |
fingerprints.sha256 |
string | |
fingerprints.sha512 |
string | |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |
Set state erred
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
RobotAccountErrorRequest - API Source:
marketplace_robot_accounts_set_state_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
error_message |
string | Error message to be saved to the robot account |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | |
fingerprints.sha256 |
string | |
fingerprints.sha512 |
string | |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |
Set state ok
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_robot_accounts_set_state_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | |
fingerprints.sha256 |
string | |
fingerprints.sha512 |
string | |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |
Set state request deletion
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | |
fingerprints.sha256 |
string | |
fingerprints.sha512 |
string | |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |