Skip to content

Marketplace Robot Accounts

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-robot-accounts/ List robot accounts
GET /api/marketplace-robot-accounts/{uuid}/ Retrieve a robot account
POST /api/marketplace-robot-accounts/ Create a robot account
PUT /api/marketplace-robot-accounts/{uuid}/ Update a robot account
PATCH /api/marketplace-robot-accounts/{uuid}/ Partially update a robot account
DELETE /api/marketplace-robot-accounts/{uuid}/ Delete a robot account
Other Actions
POST /api/marketplace-robot-accounts/{uuid}/set_state_creating/ Set robot account state to creating
POST /api/marketplace-robot-accounts/{uuid}/set_state_deleted/ Set robot account state to deleted
POST /api/marketplace-robot-accounts/{uuid}/set_state_erred/ Set robot account state to erred
POST /api/marketplace-robot-accounts/{uuid}/set_state_ok/ Set robot account state to OK
POST /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/ Request deletion of a robot account

Core CRUD

List robot accounts

Returns a paginated list of robot accounts accessible to the current user.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-robot-accounts/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_robot_accounts_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceRobotAccountsList } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
customer_uuid string (uuid) Customer 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) Project UUID
provider_uuid string (uuid) Provider UUID
resource string Resource URL
resource_uuid string (uuid) Resource UUID
state integer Robot account state


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 a robot account

Returns the details of a specific robot account.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_robot_accounts_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
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 a robot account

Creates a new robot account for a specific resource. This is typically used for automated access to a resource, e.g., for CI/CD pipelines.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-robot-accounts/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  type="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.robot_account_request import RobotAccountRequest # (1)
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RobotAccountRequest(
    resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    type="string-value"
)
response = marketplace_robot_accounts_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RobotAccountRequest
  2. API Source: marketplace_robot_accounts_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplaceRobotAccountsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "resource": "https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "type": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
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 a robot account

Updates the properties of a robot account, such as its username or associated users. Not allowed for synchronized remote accounts.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  type="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.robot_account_request import RobotAccountRequest # (1)
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RobotAccountRequest(
    resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    type="string-value"
)
response = marketplace_robot_accounts_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RobotAccountRequest
  2. API Source: marketplace_robot_accounts_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceRobotAccountsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "resource": "https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "type": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
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)

Partially update a robot account

Partially updates the properties of a robot account. Not allowed for synchronized remote accounts.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_robot_account_request import PatchedRobotAccountRequest # (1)
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRobotAccountRequest()
response = marketplace_robot_accounts_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRobotAccountRequest
  2. API Source: marketplace_robot_accounts_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
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 a robot account

Deletes a robot account. This is a hard delete and should be used with caution.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_robot_accounts_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Set robot account state to creating

Transitions the robot account state from 'Requested' to 'Creating'. This is typically used by an agent to signal that the creation process has started.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_creating/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_set_state_creating # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_set_state_creating.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_robot_accounts_set_state_creating
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsSetStateCreating } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsSetStateCreating({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
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 robot account state to deleted

Transitions the robot account state from 'Requested deletion' to 'Deleted', marking the successful completion of the deletion process.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_deleted/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_set_state_deleted # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_set_state_deleted.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_robot_accounts_set_state_deleted
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsSetStateDeleted } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsSetStateDeleted({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
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 robot account state to erred

Manually moves the robot account into the 'Error' state. An optional error message can be provided.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.robot_account_error_request import RobotAccountErrorRequest # (1)
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_set_state_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RobotAccountErrorRequest()
response = marketplace_robot_accounts_set_state_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RobotAccountErrorRequest
  2. API Source: marketplace_robot_accounts_set_state_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsSetStateErred } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsSetStateErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
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

400 -

Field Type Description
detail string Error message to be displayed to the user

Set robot account state to OK

Manually sets the robot account state to 'OK', indicating that it is fully operational. This can be used to recover from an error state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_set_state_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_set_state_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_robot_accounts_set_state_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsSetStateOk } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsSetStateOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
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

Request deletion of a robot account

Transitions the robot account state from 'OK' to 'Requested deletion', initiating the deletion process.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_request_deletion/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_set_state_request_deletion # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_set_state_request_deletion.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_robot_accounts_set_state_request_deletion
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsSetStateRequestDeletion } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsSetStateRequestDeletion({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
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