Bring a workspace up

import requests

url = "https://platform.ankra.app/api/v1/org/workspaces"

payload = {
    "idle_ttl_hours": 360,
    "kind": "<string>",
    "name": "<string>",
    "owner": "<string>",
    "repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idle_ttl_hours: 360,
    kind: '<string>',
    name: '<string>',
    owner: '<string>',
    repository_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://platform.ankra.app/api/v1/org/workspaces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://platform.ankra.app/api/v1/org/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idle_ttl_hours": 360,
  "kind": "<string>",
  "name": "<string>",
  "owner": "<string>",
  "repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idle_ttl_hours": 123,
  "image": "<string>",
  "image_source": "repository_profile",
  "kind": "<string>",
  "last_error": "<string>",
  "last_used_at": "2023-11-07T05:31:56Z",
  "namespace": "<string>",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pod_name": "<string>",
  "repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sandbox_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "spec_hash": "<string>",
  "status": "provisioning",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idle_ttl_hours": 123,
  "image": "<string>",
  "image_source": "repository_profile",
  "kind": "<string>",
  "last_error": "<string>",
  "last_used_at": "2023-11-07T05:31:56Z",
  "namespace": "<string>",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pod_name": "<string>",
  "repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sandbox_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "spec_hash": "<string>",
  "status": "provisioning",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "<string>",
  "error_code": "CLUSTER_OFFLINE",
  "retry_after": 123
}

Workspaces

Bring a workspace up

Bearer PAT authentication; RBAC permission workspaces.use. Brings the caller’s workspace for a repository and kind up, or answers the live one: 201 with a workspace this call created (placed on the repository’s CI cluster, else the organisation’s CI pool, else its pipeline cluster, and provisioning until a read finds its pod ready), 200 with the existing one. A ready workspace whose profile changed, and a failed one, are replaced.

POST

api

org

workspaces

Bring a workspace up

import requests

url = "https://platform.ankra.app/api/v1/org/workspaces"

payload = {
    "idle_ttl_hours": 360,
    "kind": "<string>",
    "name": "<string>",
    "owner": "<string>",
    "repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idle_ttl_hours: 360,
    kind: '<string>',
    name: '<string>',
    owner: '<string>',
    repository_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://platform.ankra.app/api/v1/org/workspaces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://platform.ankra.app/api/v1/org/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idle_ttl_hours": 360,
  "kind": "<string>",
  "name": "<string>",
  "owner": "<string>",
  "repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idle_ttl_hours": 123,
  "image": "<string>",
  "image_source": "repository_profile",
  "kind": "<string>",
  "last_error": "<string>",
  "last_used_at": "2023-11-07T05:31:56Z",
  "namespace": "<string>",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pod_name": "<string>",
  "repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sandbox_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "spec_hash": "<string>",
  "status": "provisioning",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idle_ttl_hours": 123,
  "image": "<string>",
  "image_source": "repository_profile",
  "kind": "<string>",
  "last_error": "<string>",
  "last_used_at": "2023-11-07T05:31:56Z",
  "namespace": "<string>",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pod_name": "<string>",
  "repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sandbox_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "spec_hash": "<string>",
  "status": "provisioning",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "<string>",
  "error_code": "CLUSTER_OFFLINE",
  "retry_after": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-ankra-organisation-id

string

PAT organisation override.

Body

application/json

Names the repository by repository_id, or by provider, owner and name as its git remote reads.

idle_ttl_hours

integer

How long a workspace this call creates lives unused (1-720, default 24).

Required range: 1 <= x <= 720

kind

string

The workspace profile to build from (default default).

name

string

owner

string

provider

enum<string>

Available options:

github,

gitlab,

bitbucket_cloud

repository_id

string<uuid>

Response

The live workspace, already up

An Ankra Workspace: a member's pod on the organisation's CI pool that commands for one repository run in.

cluster_id

string<uuid> | null

required

The cluster the workspace was placed on, once, at its first bring-up.

created_at

string<date-time>

required

expires_at

string<date-time> | null

required

When the platform removes the workspace if nothing uses it first.

string<uuid>

required

idle_ttl_hours

integer

required

How long the workspace lives unused.

image

string | null

required

The toolchain image its main container runs.

image_source

enum<string> | null

required

Where the image came from.

Available options:

repository_profile,

pipeline_stage,

pipeline_defaults,

null

kind

string

required

The workspace profile it was built from.

last_error

string | null

required

Why the workspace failed, or why the platform removed it.

last_used_at

string<date-time>

required

namespace

string | null

required

The Kubernetes namespace it runs in.

organisation_id

string<uuid>

required

pod_name

string | null

required

The pod commands run in.

repository_id

string<uuid>

required

sandbox_environment_id

string<uuid> | null

required

The sandbox environment that owns its namespace.

spec_hash

string | null

required

SHA-256 of the objects it was rendered from.

status

enum<string>

required

Available options:

provisioning,

ready,

failed,

tearing_down,

destroyed

updated_at

string<date-time>

required

user_id

string<uuid>

required

The member the workspace belongs to.

API reference

Endpoints

Bring a workspace up

Authorizations

Headers

Body

Response