Skip to content

Marketplace Site Agent Identities

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-site-agent-identities/ List Marketplace Site Agent Identities
GET /api/marketplace-site-agent-identities/{uuid}/ Retrieve
POST /api/marketplace-site-agent-identities/ Create
PUT /api/marketplace-site-agent-identities/{uuid}/ Update
DELETE /api/marketplace-site-agent-identities/{uuid}/ Delete
Other Actions
POST /api/marketplace-site-agent-identities/{uuid}/register_event_subscription/ Register event subscription
POST /api/marketplace-site-agent-identities/{uuid}/register_service/ Register a new processor or get the existing one for the agent service

Core CRUD

List Marketplace Site Agent Identities

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-site-agent-identities/ \
  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_site_agent_identities import marketplace_site_agent_identities_list # (1)

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

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

try {
  const response = await marketplaceSiteAgentIdentitiesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
last_restarted string (date-time) Last restarted after
name string
offering_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
version string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
offering string (uuid)
name string
version string
dependencies any
config_file_path string Example: '/etc/waldur/agent.yaml'
config_file_content string
last_restarted string (date-time)
created string (date-time)
modified string (date-time)
services array of objects
services.uuid string (uuid)
services.url string (uri)
services.name string
services.mode string
services.state any
services.statistics any
services.created string (date-time)
services.modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-site-agent-identities/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_site_agent_identities import marketplace_site_agent_identities_retrieve # (1)

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

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

try {
  const response = await marketplaceSiteAgentIdentitiesRetrieve({
  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
uuid string (uuid)
url string (uri)
offering string (uuid)
name string
version string
dependencies any
config_file_path string Example: '/etc/waldur/agent.yaml'
config_file_content string
last_restarted string (date-time)
created string (date-time)
modified string (date-time)
services array of objects
services.uuid string (uuid)
services.url string (uri)
services.name string
services.mode string
services.state any
services.statistics any
services.created string (date-time)
services.modified string (date-time)

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-site-agent-identities/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  name="my-awesome-marketplace-site-agent-identity"

 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.agent_identity_request import AgentIdentityRequest # (1)
from waldur_api_client.api.marketplace_site_agent_identities import marketplace_site_agent_identities_create # (2)

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

body_data = AgentIdentityRequest(
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    name="my-awesome-marketplace-site-agent-identity"
)
response = marketplace_site_agent_identities_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceSiteAgentIdentitiesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "my-awesome-marketplace-site-agent-identity"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
offering string (uuid) ✓
name string ✓
version string
dependencies any
config_file_path string Example: '/etc/waldur/agent.yaml'
config_file_content string
last_restarted string (date-time)

201 -

Field Type Description
uuid string (uuid)
url string (uri)
offering string (uuid)
name string
version string
dependencies any
config_file_path string Example: '/etc/waldur/agent.yaml'
config_file_content string
last_restarted string (date-time)
created string (date-time)
modified string (date-time)
services array of objects
services.uuid string (uuid)
services.url string (uri)
services.name string
services.mode string
services.state any
services.statistics any
services.created string (date-time)
services.modified string (date-time)

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/marketplace-site-agent-identities/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  name="my-awesome-marketplace-site-agent-identity"

 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.agent_identity_request import AgentIdentityRequest # (1)
from waldur_api_client.api.marketplace_site_agent_identities import marketplace_site_agent_identities_update # (2)

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

body_data = AgentIdentityRequest(
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    name="my-awesome-marketplace-site-agent-identity"
)
response = marketplace_site_agent_identities_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceSiteAgentIdentitiesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "my-awesome-marketplace-site-agent-identity"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
offering string (uuid) ✓
name string ✓
version string
dependencies any
config_file_path string Example: '/etc/waldur/agent.yaml'
config_file_content string
last_restarted string (date-time)

200 -

Field Type Description
uuid string (uuid)
url string (uri)
offering string (uuid)
name string
version string
dependencies any
config_file_path string Example: '/etc/waldur/agent.yaml'
config_file_content string
last_restarted string (date-time)
created string (date-time)
modified string (date-time)
services array of objects
services.uuid string (uuid)
services.url string (uri)
services.name string
services.mode string
services.state any
services.statistics any
services.created string (date-time)
services.modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-site-agent-identities/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_site_agent_identities import marketplace_site_agent_identities_destroy # (1)

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

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

try {
  const response = await marketplaceSiteAgentIdentitiesDestroy({
  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

Register event subscription

Register an event subscription for the specified agent identity and observable object type. Returns existing subscription if already exists.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-site-agent-identities/a1b2c3d4-e5f6-7890-abcd-ef1234567890/register_event_subscription/ \
  Authorization:"Token YOUR_API_TOKEN" \
  observable_object_type=null

 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.agent_event_subscription_create_request import AgentEventSubscriptionCreateRequest # (1)
from waldur_api_client.api.marketplace_site_agent_identities import marketplace_site_agent_identities_register_event_subscription # (2)

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

body_data = AgentEventSubscriptionCreateRequest(
    observable_object_type=null
)
response = marketplace_site_agent_identities_register_event_subscription.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceSiteAgentIdentitiesRegisterEventSubscription({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "observable_object_type": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
observable_object_type any ✓ The type of object to observe for events
description string Optional description for the event subscription

200 -

Field Type Description
uuid string (uuid)
url string (uri)
description string
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
observable_objects any
created string (date-time)
modified string (date-time)
source_ip any An IPv4 or IPv6 address.

201 -

Field Type Description
uuid string (uuid)
url string (uri)
description string
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
observable_objects any
created string (date-time)
modified string (date-time)
source_ip any An IPv4 or IPv6 address.

Register a new processor or get the existing one for the agent service

Register a new processor or get the existing one for the agent service

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-site-agent-identities/a1b2c3d4-e5f6-7890-abcd-ef1234567890/register_service/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-site-agent-identity"

 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.agent_service_create_request import AgentServiceCreateRequest # (1)
from waldur_api_client.api.marketplace_site_agent_identities import marketplace_site_agent_identities_register_service # (2)

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

body_data = AgentServiceCreateRequest(
    name="my-awesome-marketplace-site-agent-identity"
)
response = marketplace_site_agent_identities_register_service.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceSiteAgentIdentitiesRegisterService({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-site-agent-identity"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
mode string

200 -

Field Type Description
uuid string (uuid)
url string (uri)
identity string (uuid)
identity_name string
name string
mode string
state any
statistics any
created string (date-time)
modified string (date-time)
processors array of objects
processors.uuid string (uuid)
processors.url string (uri)
processors.name string
processors.last_run string (date-time)
processors.backend_type string Type of the backend, for example SLURM.
processors.backend_version string
processors.created string (date-time)
processors.modified string (date-time)

201 -

Field Type Description
uuid string (uuid)
url string (uri)
identity string (uuid)
identity_name string
name string
mode string
state any
statistics any
created string (date-time)
modified string (date-time)
processors array of objects
processors.uuid string (uuid)
processors.url string (uri)
processors.name string
processors.last_run string (date-time)
processors.backend_type string Type of the backend, for example SLURM.
processors.backend_version string
processors.created string (date-time)
processors.modified string (date-time)