Skip to main content
API docs by Redocly

Orchestration (0.1)

Download OpenAPI specification:Download

API Documentation for Orchestration

PayloadsServiceV0

ListPayloads

Lists payloads for a specified project ID and allocation ID.

Authorizations:
OAuth2
path Parameters
project_id
required
string

ID of the project to use.

allocation_id
required
string

ID of the allocation to use.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

GetPayload

Retrieves a single payload with a specified ID.

Authorizations:
OAuth2
path Parameters
project_id
required
string

ID of the project to use.

allocation_id
required
string

ID of the allocation to use.

payload_id
required
string

ID of the payload to use.

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

DeletePayload

Deletes a single payload for a specified project, allocation, and payload ID. Note: It can take some time to delete a payload. During the deletion process you can list and query a payload, but you can't reserve it.

Authorizations:
OAuth2
path Parameters
project_id
required
string

ID of the project to use.

allocation_id
required
string

ID of the allocation to use.

payload_id
required
string

ID of the payload to use.

query Parameters
force_delete
boolean

Deletes a payload with "reserved" status.

Responses

Response samples

Content type
application/json
{ }

SetPayloadAnnotation sets an annotation on a single payload.

Set an annotation on the payload's metadata.

Authorizations:
OAuth2
path Parameters
project_id
required
string

project_id is the ID of the project containing the Allocation.

allocation_id
required
string

allocation_id is the ID of the Allocation running the Payload.

payload_id
required
string

payload_id is the ID of the Payload.

Request Body schema: application/json
key
required
string

key is the key of the annotation. An existing key will overwrite the corresponding annotation, a new key will create a new annotation. A valid annotation key:

  • must be 59 characters or less (cannot be empty),
  • must begin and end with an alphanumeric character ([a-z0-9A-Z]),
  • could contain dashes (-), underscores (_), dots (.), and alphanumerics between.
value
required
string

value is the new value of the annotation. Can have arbitrary data. Can be used to e.g. pass custom data to a matchmaker.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{ }

SetPayloadLabel sets a label on a single payload.

Set a label on the payload's metadata.

Authorizations:
OAuth2
path Parameters
project_id
required
string

project_id is the ID of the project containing the Allocation.

allocation_id
required
string

allocation_id is the ID of the Allocation running the Payload.

payload_id
required
string

payload_id is the ID of the Payload.

Request Body schema: application/json
key
required
string

key is the key of the label. An existing key will overwrite the corresponding label, a new key will create a new label. A valid label key:

  • must be 59 characters or less (cannot be empty),
  • must begin and end with an alphanumeric character ([a-z0-9A-Z]),
  • could contain dashes (-), underscores (_), dots (.), and alphanumerics between.
value
required
string

value is the new value of the label. A valid label value:

  • must be 63 characters or less (can be empty),
  • unless empty, must begin and end with an alphanumeric character ([a-z0-9A-Z]),
  • could contain dashes (-), underscores (_), dots (.), and alphanumerics between.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{ }

AllocationsServiceV0

ListAllocations

Lists allocations for a specified project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

ID of the project to list allocations in.

query Parameters
limit
integer <int32>

Maximum number of results to return, in the range 1-1000. Default is 1000.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

CreateAllocation

Create an allocation in a specified project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

ID of the project in which to create the allocation.

Request Body schema: application/json
required
object (v0AllocationSpec)
name
string

Allocation name.

object or null (v0AllocationMetadata)

Responses

Request samples

Content type
application/json
{
  • "spec": {
    },
  • "name": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

GetAllocation

Retrieves a single allocation in a specified project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

ID of the project the allocation belongs to.

allocation_id
required
string

ID of the allocation to retrieve.

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

UpdateAllocation

Updates a single allocation in a specified project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

ID of the project the allocation belongs to.

allocation_id
required
string

ID of the allocation to update.

Request Body schema: application/json
required
object (v0AllocationSpec)
name
required
string

Name of the allocation.

object or null (v0AllocationMetadata)

Responses

Request samples

Content type
application/json
{
  • "spec": {
    },
  • "name": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DeleteAllocation

Deletes a single allocation in a specified project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

ID of the project the allocation belongs to.

allocation_id
required
string

ID of the allocation to delete.

Responses

Response samples

Content type
application/json
{ }

SetAllocationEnabled

Enable or disable a single allocation in a specified project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

ID of the project the allocation belongs to.

allocation_id
required
string

ID of the allocation to update.

Request Body schema: application/json
enabled
required
boolean (Should be set to true to enable and false to disable)

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{ }

UpdateAllocationImage

Updates the image of a single allocation in a specified project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

ID of the project the allocation belongs to.

allocation_id
required
string

ID of the allocation to update.

Request Body schema: application/json
image
required
string

Image of the allocation.

Responses

Request samples

Content type
application/json
{
  • "image": "string"
}

Response samples

Content type
application/json
{ }

ArtefactsV0

ListArtefacts

Authorizations:
OAuth2
path Parameters
project_id
required
string

project_id - the project to which the artefacts belong to

allocation_id
required
string

allocation_id - the allocation to which the artefacts belong to

query Parameters
page_size
integer <int32>

page_size - the maximum number of results to be returned by the server (max: 1000, default: 1000)

page_token
string

page_token - used to request a specific page of the list results.

payload_id
string

payload_id - use to filter the results to only those artefacts belonging to a specific payload.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "next_page_token": "string"
}

GetArtefact

Authorizations:
OAuth2
path Parameters
project_id
required
string

project_id - the project to which the artefact belongs to

allocation_id
required
string

allocation_id - the allocation to which the artefact belongs to

payload_id
required
string

payload_id - the payload to which the artefacts belong to

query Parameters
file_path
string

file_path - the filePath of the artefact

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

ReservationsServiceV0

DeleteReservation

Deletes a single payload reservation from a specified project and allocation.

Authorizations:
OAuth2
path Parameters
project_id
required
string

ID of the project to use.

allocation_id
required
string

ID of the allocation to use.

payload_id
required
string

ID of the payload to use.

Responses

Response samples

Content type
application/json
{ }

CreateReservation

Reserves a payload in a specified project and allocation.

Authorizations:
OAuth2
path Parameters
project_id
required
string

ID of the project to use.

allocation_id
required
string

ID of the allocation to use.

Request Body schema: application/json
object (v0PayloadMetadata)
Array of objects (v0PayloadSelector)

selectors is an ordered list of payload selectors used to prioritise/filter which payloads can satisfy the reservation. Each selector matches specific payloads that can be reserved, based on e.g. labels on the payload's metadata. The selectors will be tried in order, if one selector doesn't match any payloads the next selector in the list will be used. If none of the selectors match any payloads, an error is returned. If empty, all Ready payloads in the allocation are considered.

Responses

Request samples

Content type
application/json
{
  • "payload_metadata": {
    },
  • "selectors": [
    ]
}

Response samples

Content type
application/json
{
  • "payload_id": "string",
  • "payload_address": "string",
  • "payload_ports": [
    ]
}