Runs

List archived runs for user

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

user*string

User

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/archives/string/runs"

{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "user": "string",      "owner": "string",      "project": "string",      "schedule_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "started_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z",      "wait_time": 0.1,      "duration": 0.1,      "managed_by": "client",      "is_managed": true,      "is_approved": true,      "pending": "approval",      "content": "string",      "raw_content": "string",      "status": "created",      "bookmarked": true,      "live_state": 0,      "readme": "string",      "meta_info": {},      "kind": "job",      "runtime": "job",      "inputs": {},      "outputs": {},      "original": {        "uuid": "string",        "name": "string",        "kind": "copy"      },      "pipeline": {        "uuid": "string",        "name": "string",        "kind": "dag"      },      "status_conditions": [        {          "type": "created",          "status": "string",          "reason": "string",          "message": "string",          "last_update_time": "2019-08-24T14:15:22Z",          "last_transition_time": "2019-08-24T14:15:22Z",          "meta_info": {}        }      ],      "role": "string",      "contributors": [        {}      ],      "settings": {        "namespace": "string",        "agent": {          "uuid": "string",          "name": "string",          "version": "string",          "url": "string"        },        "queue": {          "uuid": "string",          "name": "string",          "version": "string",          "url": "string"        },        "artifacts_store": {          "uuid": "string",          "name": "string",          "version": "string",          "url": "string"        },        "tensorboard": {},        "build": {},        "component": {},        "models": [          {            "owner": "string",            "project": "string",            "name": "string",            "state": "string"          }        ],        "artifacts": [          {            "owner": "string",            "project": "string",            "name": "string",            "state": "string"          }        ]      },      "resources": {        "cpu": 0.1,        "memory": 0.1,        "gpu": 0.1,        "custom": 0.1,        "cost": 0.1      },      "graph": {},      "merge": true    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List bookmarked runs for user

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

user*string

User

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/bookmarks/string/runs"

{  "count": 0,  "results": [    {}  ],  "previous": "string",  "next": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs/string"

{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "user": "string",  "owner": "string",  "project": "string",  "schedule_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "wait_time": 0.1,  "duration": 0.1,  "managed_by": "client",  "is_managed": true,  "is_approved": true,  "pending": "approval",  "content": "string",  "raw_content": "string",  "status": "created",  "bookmarked": true,  "live_state": 0,  "readme": "string",  "meta_info": {},  "kind": "job",  "runtime": "job",  "inputs": {},  "outputs": {},  "original": {    "uuid": "string",    "name": "string",    "kind": "copy"  },  "pipeline": {    "uuid": "string",    "name": "string",    "kind": "dag"  },  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "role": "string",  "contributors": [    {}  ],  "settings": {    "namespace": "string",    "agent": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "queue": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "artifacts_store": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "tensorboard": {},    "build": {},    "component": {},    "models": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ],    "artifacts": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ]  },  "resources": {    "cpu": 0.1,    "memory": 0.1,    "gpu": 0.1,    "custom": 0.1,    "cost": 0.1  },  "graph": {},  "merge": true}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/string/string/runs/string"

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Approve run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/approve"

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Archive run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/archive"

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Bookmark run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/bookmark"

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Impersonate run token

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/impersonate"

{  "token": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Invalidate run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/invalidate"

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run artifacts lineage

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity name under namespace

uuid*string

SubEntity uuid

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs/string/lineage/artifacts"

{  "count": 0,  "results": [    {      "name": "string",      "state": "string",      "kind": "model",      "path": "string",      "connection": "string",      "run": "string",      "summary": {},      "is_input": true,      "meta_info": {}    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run artifacts lineage names

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity name under namespace

uuid*string

SubEntity uuid

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs/string/lineage/artifacts/names"

{  "count": 0,  "results": [    {      "name": "string",      "state": "string",      "kind": "model",      "path": "string",      "connection": "string",      "run": "string",      "summary": {},      "is_input": true,      "meta_info": {}    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run clones lineage

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity name under namespace

uuid*string

SubEntity uuid

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs/string/lineage/clones"

{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "user": "string",      "owner": "string",      "project": "string",      "schedule_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "started_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z",      "wait_time": 0.1,      "duration": 0.1,      "managed_by": "client",      "is_managed": true,      "is_approved": true,      "pending": "approval",      "content": "string",      "raw_content": "string",      "status": "created",      "bookmarked": true,      "live_state": 0,      "readme": "string",      "meta_info": {},      "kind": "job",      "runtime": "job",      "inputs": {},      "outputs": {},      "original": {        "uuid": "string",        "name": "string",        "kind": "copy"      },      "pipeline": {        "uuid": "string",        "name": "string",        "kind": "dag"      },      "status_conditions": [        {          "type": "created",          "status": "string",          "reason": "string",          "message": "string",          "last_update_time": "2019-08-24T14:15:22Z",          "last_transition_time": "2019-08-24T14:15:22Z",          "meta_info": {}        }      ],      "role": "string",      "contributors": [        {}      ],      "settings": {        "namespace": "string",        "agent": {          "uuid": "string",          "name": "string",          "version": "string",          "url": "string"        },        "queue": {          "uuid": "string",          "name": "string",          "version": "string",          "url": "string"        },        "artifacts_store": {          "uuid": "string",          "name": "string",          "version": "string",          "url": "string"        },        "tensorboard": {},        "build": {},        "component": {},        "models": [          {            "owner": "string",            "project": "string",            "name": "string",            "state": "string"          }        ],        "artifacts": [          {            "owner": "string",            "project": "string",            "name": "string",            "state": "string"          }        ]      },      "resources": {        "cpu": 0.1,        "memory": 0.1,        "gpu": 0.1,        "custom": 0.1,        "cost": 0.1      },      "graph": {},      "merge": true    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run connections lineage

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity name under namespace

uuid*string

SubEntity uuid

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs/string/lineage/connections"

{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "kind": "string"    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run downstream lineage

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity name under namespace

uuid*string

SubEntity uuid

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs/string/lineage/downstream"

{  "count": 0,  "results": [    {      "upstream": {        "uuid": "string",        "name": "string",        "description": "string",        "tags": [          "string"        ],        "user": "string",        "owner": "string",        "project": "string",        "schedule_at": "2019-08-24T14:15:22Z",        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z",        "started_at": "2019-08-24T14:15:22Z",        "finished_at": "2019-08-24T14:15:22Z",        "wait_time": 0.1,        "duration": 0.1,        "managed_by": "client",        "is_managed": true,        "is_approved": true,        "pending": "approval",        "content": "string",        "raw_content": "string",        "status": "created",        "bookmarked": true,        "live_state": 0,        "readme": "string",        "meta_info": {},        "kind": "job",        "runtime": "job",        "inputs": {},        "outputs": {},        "original": {          "uuid": "string",          "name": "string",          "kind": "copy"        },        "pipeline": {          "uuid": "string",          "name": "string",          "kind": "dag"        },        "status_conditions": [          {            "type": "created",            "status": "string",            "reason": "string",            "message": "string",            "last_update_time": "2019-08-24T14:15:22Z",            "last_transition_time": "2019-08-24T14:15:22Z",            "meta_info": {}          }        ],        "role": "string",        "contributors": [          {}        ],        "settings": {          "namespace": "string",          "agent": {            "uuid": "string",            "name": "string",            "version": "string",            "url": "string"          },          "queue": {            "uuid": "string",            "name": "string",            "version": "string",            "url": "string"          },          "artifacts_store": {            "uuid": "string",            "name": "string",            "version": "string",            "url": "string"          },          "tensorboard": {},          "build": {},          "component": {},          "models": [            {              "owner": "string",              "project": "string",              "name": "string",              "state": "string"            }          ],          "artifacts": [            {              "owner": "string",              "project": "string",              "name": "string",              "state": "string"            }          ]        },        "resources": {          "cpu": 0.1,          "memory": 0.1,          "gpu": 0.1,          "custom": 0.1,          "cost": 0.1        },        "graph": {},        "merge": true      },      "downstream": {        "uuid": "string",        "name": "string",        "description": "string",        "tags": [          "string"        ],        "user": "string",        "owner": "string",        "project": "string",        "schedule_at": "2019-08-24T14:15:22Z",        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z",        "started_at": "2019-08-24T14:15:22Z",        "finished_at": "2019-08-24T14:15:22Z",        "wait_time": 0.1,        "duration": 0.1,        "managed_by": "client",        "is_managed": true,        "is_approved": true,        "pending": "approval",        "content": "string",        "raw_content": "string",        "status": "created",        "bookmarked": true,        "live_state": 0,        "readme": "string",        "meta_info": {},        "kind": "job",        "runtime": "job",        "inputs": {},        "outputs": {},        "original": {          "uuid": "string",          "name": "string",          "kind": "copy"        },        "pipeline": {          "uuid": "string",          "name": "string",          "kind": "dag"        },        "status_conditions": [          {            "type": "created",            "status": "string",            "reason": "string",            "message": "string",            "last_update_time": "2019-08-24T14:15:22Z",            "last_transition_time": "2019-08-24T14:15:22Z",            "meta_info": {}          }        ],        "role": "string",        "contributors": [          {}        ],        "settings": {          "namespace": "string",          "agent": {            "uuid": "string",            "name": "string",            "version": "string",            "url": "string"          },          "queue": {            "uuid": "string",            "name": "string",            "version": "string",            "url": "string"          },          "artifacts_store": {            "uuid": "string",            "name": "string",            "version": "string",            "url": "string"          },          "tensorboard": {},          "build": {},          "component": {},          "models": [            {              "owner": "string",              "project": "string",              "name": "string",              "state": "string"            }          ],          "artifacts": [            {              "owner": "string",              "project": "string",              "name": "string",              "state": "string"            }          ]        },        "resources": {          "cpu": 0.1,          "memory": 0.1,          "gpu": 0.1,          "custom": 0.1,          "cost": 0.1        },        "graph": {},        "merge": true      },      "kind": "action",      "values": {},      "statuses": [        "created"      ]    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run upstream lineage

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity name under namespace

uuid*string

SubEntity uuid

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs/string/lineage/upstream"

{  "count": 0,  "results": [    {      "upstream": {        "uuid": "string",        "name": "string",        "description": "string",        "tags": [          "string"        ],        "user": "string",        "owner": "string",        "project": "string",        "schedule_at": "2019-08-24T14:15:22Z",        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z",        "started_at": "2019-08-24T14:15:22Z",        "finished_at": "2019-08-24T14:15:22Z",        "wait_time": 0.1,        "duration": 0.1,        "managed_by": "client",        "is_managed": true,        "is_approved": true,        "pending": "approval",        "content": "string",        "raw_content": "string",        "status": "created",        "bookmarked": true,        "live_state": 0,        "readme": "string",        "meta_info": {},        "kind": "job",        "runtime": "job",        "inputs": {},        "outputs": {},        "original": {          "uuid": "string",          "name": "string",          "kind": "copy"        },        "pipeline": {          "uuid": "string",          "name": "string",          "kind": "dag"        },        "status_conditions": [          {            "type": "created",            "status": "string",            "reason": "string",            "message": "string",            "last_update_time": "2019-08-24T14:15:22Z",            "last_transition_time": "2019-08-24T14:15:22Z",            "meta_info": {}          }        ],        "role": "string",        "contributors": [          {}        ],        "settings": {          "namespace": "string",          "agent": {            "uuid": "string",            "name": "string",            "version": "string",            "url": "string"          },          "queue": {            "uuid": "string",            "name": "string",            "version": "string",            "url": "string"          },          "artifacts_store": {            "uuid": "string",            "name": "string",            "version": "string",            "url": "string"          },          "tensorboard": {},          "build": {},          "component": {},          "models": [            {              "owner": "string",              "project": "string",              "name": "string",              "state": "string"            }          ],          "artifacts": [            {              "owner": "string",              "project": "string",              "name": "string",              "state": "string"            }          ]        },        "resources": {          "cpu": 0.1,          "memory": 0.1,          "gpu": 0.1,          "custom": 0.1,          "cost": 0.1        },        "graph": {},        "merge": true      },      "downstream": {        "uuid": "string",        "name": "string",        "description": "string",        "tags": [          "string"        ],        "user": "string",        "owner": "string",        "project": "string",        "schedule_at": "2019-08-24T14:15:22Z",        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z",        "started_at": "2019-08-24T14:15:22Z",        "finished_at": "2019-08-24T14:15:22Z",        "wait_time": 0.1,        "duration": 0.1,        "managed_by": "client",        "is_managed": true,        "is_approved": true,        "pending": "approval",        "content": "string",        "raw_content": "string",        "status": "created",        "bookmarked": true,        "live_state": 0,        "readme": "string",        "meta_info": {},        "kind": "job",        "runtime": "job",        "inputs": {},        "outputs": {},        "original": {          "uuid": "string",          "name": "string",          "kind": "copy"        },        "pipeline": {          "uuid": "string",          "name": "string",          "kind": "dag"        },        "status_conditions": [          {            "type": "created",            "status": "string",            "reason": "string",            "message": "string",            "last_update_time": "2019-08-24T14:15:22Z",            "last_transition_time": "2019-08-24T14:15:22Z",            "meta_info": {}          }        ],        "role": "string",        "contributors": [          {}        ],        "settings": {          "namespace": "string",          "agent": {            "uuid": "string",            "name": "string",            "version": "string",            "url": "string"          },          "queue": {            "uuid": "string",            "name": "string",            "version": "string",            "url": "string"          },          "artifacts_store": {            "uuid": "string",            "name": "string",            "version": "string",            "url": "string"          },          "tensorboard": {},          "build": {},          "component": {},          "models": [            {              "owner": "string",              "project": "string",              "name": "string",              "state": "string"            }          ],          "artifacts": [            {              "owner": "string",              "project": "string",              "name": "string",              "state": "string"            }          ]        },        "resources": {          "cpu": 0.1,          "memory": 0.1,          "gpu": 0.1,          "custom": 0.1,          "cost": 0.1        },        "graph": {},        "merge": true      },      "kind": "action",      "values": {},      "statuses": [        "created"      ]    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get Run namespace

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs/string/namespace"

{  "namespace": "string",  "agent": {    "uuid": "string",    "name": "string",    "version": "string",    "url": "string"  },  "queue": {    "uuid": "string",    "name": "string",    "version": "string",    "url": "string"  },  "artifacts_store": {    "uuid": "string",    "name": "string",    "version": "string",    "url": "string"  },  "tensorboard": {},  "build": {},  "component": {},  "models": [    {      "owner": "string",      "project": "string",      "name": "string",      "state": "string"    }  ],  "artifacts": [    {      "owner": "string",      "project": "string",      "name": "string",      "state": "string"    }  ]}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Restore run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/restore"

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get Run settings

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs/string/settings"

{  "namespace": "string",  "agent": {    "uuid": "string",    "name": "string",    "version": "string",    "url": "string"  },  "queue": {    "uuid": "string",    "name": "string",    "version": "string",    "url": "string"  },  "artifacts_store": {    "uuid": "string",    "name": "string",    "version": "string",    "url": "string"  },  "tensorboard": {},  "build": {},  "component": {},  "models": [    {      "owner": "string",      "project": "string",      "name": "string",      "state": "string"    }  ],  "artifacts": [    {      "owner": "string",      "project": "string",      "name": "string",      "state": "string"    }  ]}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Skip run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/skip"

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run stats

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity name under namespace

uuid*string

SubEntity uuid

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Stats Mode.

kind?string

Stats Kind.

aggregate?string

Stats aggregate.

groupby?string

Stats group.

trunc?string

Stats trunc.

start_date?string

Stats start date.

end_date?string

Stats end date.

boundary?boolean

Stats boundary.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs/string/stats"

{}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run statuses

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs/string/statuses"

{  "uuid": "string",  "status": "created",  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "meta_info": {}}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Stop run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/stop"

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Unbookmark run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/string/string/runs/string/unbookmark"

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List runs

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity managing the resource

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs"

{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "user": "string",      "owner": "string",      "project": "string",      "schedule_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "started_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z",      "wait_time": 0.1,      "duration": 0.1,      "managed_by": "client",      "is_managed": true,      "is_approved": true,      "pending": "approval",      "content": "string",      "raw_content": "string",      "status": "created",      "bookmarked": true,      "live_state": 0,      "readme": "string",      "meta_info": {},      "kind": "job",      "runtime": "job",      "inputs": {},      "outputs": {},      "original": {        "uuid": "string",        "name": "string",        "kind": "copy"      },      "pipeline": {        "uuid": "string",        "name": "string",        "kind": "dag"      },      "status_conditions": [        {          "type": "created",          "status": "string",          "reason": "string",          "message": "string",          "last_update_time": "2019-08-24T14:15:22Z",          "last_transition_time": "2019-08-24T14:15:22Z",          "meta_info": {}        }      ],      "role": "string",      "contributors": [        {}      ],      "settings": {        "namespace": "string",        "agent": {          "uuid": "string",          "name": "string",          "version": "string",          "url": "string"        },        "queue": {          "uuid": "string",          "name": "string",          "version": "string",          "url": "string"        },        "artifacts_store": {          "uuid": "string",          "name": "string",          "version": "string",          "url": "string"        },        "tensorboard": {},        "build": {},        "component": {},        "models": [          {            "owner": "string",            "project": "string",            "name": "string",            "state": "string"          }        ],        "artifacts": [          {            "owner": "string",            "project": "string",            "name": "string",            "state": "string"          }        ]      },      "resources": {        "cpu": 0.1,        "memory": 0.1,        "gpu": 0.1,        "custom": 0.1,        "cost": 0.1      },      "graph": {},      "merge": true    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Approve runs

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity under namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

uuids?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/approve" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Archive runs

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity under namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

uuids?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/archive" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Bookmark runs

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity under namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

uuids?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/bookmark" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete runs

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity under namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

uuids?array<string>

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/string/string/runs/delete" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Invalidate runs

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity under namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

uuids?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/invalidate" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get runs artifacts lineage

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity managing the resource

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs/lineage/artifacts"

{  "count": 0,  "results": [    {      "name": "string",      "state": "string",      "kind": "model",      "path": "string",      "connection": "string",      "run": "string",      "summary": {},      "is_input": true,      "meta_info": {}    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Restore runs

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity under namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

uuids?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/restore" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Skip runs

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity under namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

uuids?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/skip" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Stop runs

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity under namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

uuids?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/stop" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Tag runs

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity under namespace

Request Body

application/json

Data

TypeScript Definitions

Use the request body type in TypeScript.

uuids?array<string>

tags?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/tag" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Transfer runs

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity under namespace

Request Body

application/json

Data

TypeScript Definitions

Use the request body type in TypeScript.

uuids?array<string>

project?string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/transfer" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Create new run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

Request Body

application/json

operation object

TypeScript Definitions

Use the request body type in TypeScript.

content?The Operation body content as dump string

is_managed?Optional, if the run is managed, true by default, this flag should be false if starting a non-managed run

managed_by?v1ManagedBy

pending?v1RunPending

name?Optional

description?Optional

tags?array<string>

meta_info?

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs" \  -H "Content-Type: application/json" \  -d '{}'

{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "user": "string",  "owner": "string",  "project": "string",  "schedule_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "wait_time": 0.1,  "duration": 0.1,  "managed_by": "client",  "is_managed": true,  "is_approved": true,  "pending": "approval",  "content": "string",  "raw_content": "string",  "status": "created",  "bookmarked": true,  "live_state": 0,  "readme": "string",  "meta_info": {},  "kind": "job",  "runtime": "job",  "inputs": {},  "outputs": {},  "original": {    "uuid": "string",    "name": "string",    "kind": "copy"  },  "pipeline": {    "uuid": "string",    "name": "string",    "kind": "dag"  },  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "role": "string",  "contributors": [    {}  ],  "settings": {    "namespace": "string",    "agent": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "queue": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "artifacts_store": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "tensorboard": {},    "build": {},    "component": {},    "models": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ],    "artifacts": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ]  },  "resources": {    "cpu": 0.1,    "memory": 0.1,    "gpu": 0.1,    "custom": 0.1,    "cost": 0.1  },  "graph": {},  "merge": true}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Sync offline run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

Request Body

application/json

Run object

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

name?Optional name

description?Optional description

tags?array<string>

user?Required name of user started this entity

owner?Required name of owner of this entity

project?Required project name

schedule_at?Optional last time the entity was started

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

started_at?Optional last time the entity was started

finished_at?Optional last time the entity was started

wait_time?Optional wait time of the entity

duration?Optional duration of the entity

managed_by?v1ManagedBy

is_managed?Optional flag to tell if this entity is managed by the platform

is_approved?Deprecated flag that was replaced by "pending", and it will be completely dropped after v1.15

pending?v1RunPending

content?Optional content of the entity's spec

raw_content?Optional content of the entity's spec

status?v1Statuses

bookmarked?Optional if this entity was bookmarked

live_state?Current live state

readme?Optional Markdown description/readme

meta_info?

kind?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

runtime?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

inputs?

outputs?

original?

pipeline?

status_conditions?array<>

role?Current user's role in this (org/teams)/project/runs

contributors?array<>

settings?

resources?

graph?

merge?Optional merge flag

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/sync" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

run.uuid*string

UUID

Request Body

application/json

Run object

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

name?Optional name

description?Optional description

tags?array<string>

user?Required name of user started this entity

owner?Required name of owner of this entity

project?Required project name

schedule_at?Optional last time the entity was started

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

started_at?Optional last time the entity was started

finished_at?Optional last time the entity was started

wait_time?Optional wait time of the entity

duration?Optional duration of the entity

managed_by?v1ManagedBy

is_managed?Optional flag to tell if this entity is managed by the platform

is_approved?Deprecated flag that was replaced by "pending", and it will be completely dropped after v1.15

pending?v1RunPending

content?Optional content of the entity's spec

raw_content?Optional content of the entity's spec

status?v1Statuses

bookmarked?Optional if this entity was bookmarked

live_state?Current live state

readme?Optional Markdown description/readme

meta_info?

kind?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

runtime?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

inputs?

outputs?

original?

pipeline?

status_conditions?array<>

role?Current user's role in this (org/teams)/project/runs

contributors?array<>

settings?

resources?

graph?

merge?Optional merge flag

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/string/string/runs/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "user": "string",  "owner": "string",  "project": "string",  "schedule_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "wait_time": 0.1,  "duration": 0.1,  "managed_by": "client",  "is_managed": true,  "is_approved": true,  "pending": "approval",  "content": "string",  "raw_content": "string",  "status": "created",  "bookmarked": true,  "live_state": 0,  "readme": "string",  "meta_info": {},  "kind": "job",  "runtime": "job",  "inputs": {},  "outputs": {},  "original": {    "uuid": "string",    "name": "string",    "kind": "copy"  },  "pipeline": {    "uuid": "string",    "name": "string",    "kind": "dag"  },  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "role": "string",  "contributors": [    {}  ],  "settings": {    "namespace": "string",    "agent": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "queue": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "artifacts_store": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "tensorboard": {},    "build": {},    "component": {},    "models": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ],    "artifacts": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ]  },  "resources": {    "cpu": 0.1,    "memory": 0.1,    "gpu": 0.1,    "custom": 0.1,    "cost": 0.1  },  "graph": {},  "merge": true}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

run.uuid*string

UUID

Request Body

application/json

Run object

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

name?Optional name

description?Optional description

tags?array<string>

user?Required name of user started this entity

owner?Required name of owner of this entity

project?Required project name

schedule_at?Optional last time the entity was started

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

started_at?Optional last time the entity was started

finished_at?Optional last time the entity was started

wait_time?Optional wait time of the entity

duration?Optional duration of the entity

managed_by?v1ManagedBy

is_managed?Optional flag to tell if this entity is managed by the platform

is_approved?Deprecated flag that was replaced by "pending", and it will be completely dropped after v1.15

pending?v1RunPending

content?Optional content of the entity's spec

raw_content?Optional content of the entity's spec

status?v1Statuses

bookmarked?Optional if this entity was bookmarked

live_state?Current live state

readme?Optional Markdown description/readme

meta_info?

kind?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

runtime?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

inputs?

outputs?

original?

pipeline?

status_conditions?array<>

role?Current user's role in this (org/teams)/project/runs

contributors?array<>

settings?

resources?

graph?

merge?Optional merge flag

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/string/string/runs/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "user": "string",  "owner": "string",  "project": "string",  "schedule_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "wait_time": 0.1,  "duration": 0.1,  "managed_by": "client",  "is_managed": true,  "is_approved": true,  "pending": "approval",  "content": "string",  "raw_content": "string",  "status": "created",  "bookmarked": true,  "live_state": 0,  "readme": "string",  "meta_info": {},  "kind": "job",  "runtime": "job",  "inputs": {},  "outputs": {},  "original": {    "uuid": "string",    "name": "string",    "kind": "copy"  },  "pipeline": {    "uuid": "string",    "name": "string",    "kind": "dag"  },  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "role": "string",  "contributors": [    {}  ],  "settings": {    "namespace": "string",    "agent": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "queue": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "artifacts_store": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "tensorboard": {},    "build": {},    "component": {},    "models": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ],    "artifacts": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ]  },  "resources": {    "cpu": 0.1,    "memory": 0.1,    "gpu": 0.1,    "custom": 0.1,    "cost": 0.1  },  "graph": {},  "merge": true}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Restart run with copy

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

run.uuid*string

UUID

Request Body

application/json

Run object

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

name?Optional name

description?Optional description

tags?array<string>

user?Required name of user started this entity

owner?Required name of owner of this entity

project?Required project name

schedule_at?Optional last time the entity was started

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

started_at?Optional last time the entity was started

finished_at?Optional last time the entity was started

wait_time?Optional wait time of the entity

duration?Optional duration of the entity

managed_by?v1ManagedBy

is_managed?Optional flag to tell if this entity is managed by the platform

is_approved?Deprecated flag that was replaced by "pending", and it will be completely dropped after v1.15

pending?v1RunPending

content?Optional content of the entity's spec

raw_content?Optional content of the entity's spec

status?v1Statuses

bookmarked?Optional if this entity was bookmarked

live_state?Current live state

readme?Optional Markdown description/readme

meta_info?

kind?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

runtime?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

inputs?

outputs?

original?

pipeline?

status_conditions?array<>

role?Current user's role in this (org/teams)/project/runs

contributors?array<>

settings?

resources?

graph?

merge?Optional merge flag

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/copy" \  -H "Content-Type: application/json" \  -d '{}'

{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "user": "string",  "owner": "string",  "project": "string",  "schedule_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "wait_time": 0.1,  "duration": 0.1,  "managed_by": "client",  "is_managed": true,  "is_approved": true,  "pending": "approval",  "content": "string",  "raw_content": "string",  "status": "created",  "bookmarked": true,  "live_state": 0,  "readme": "string",  "meta_info": {},  "kind": "job",  "runtime": "job",  "inputs": {},  "outputs": {},  "original": {    "uuid": "string",    "name": "string",    "kind": "copy"  },  "pipeline": {    "uuid": "string",    "name": "string",    "kind": "dag"  },  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "role": "string",  "contributors": [    {}  ],  "settings": {    "namespace": "string",    "agent": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "queue": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "artifacts_store": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "tensorboard": {},    "build": {},    "component": {},    "models": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ],    "artifacts": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ]  },  "resources": {    "cpu": 0.1,    "memory": 0.1,    "gpu": 0.1,    "custom": 0.1,    "cost": 0.1  },  "graph": {},  "merge": true}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Restart run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

run.uuid*string

UUID

Request Body

application/json

Run object

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

name?Optional name

description?Optional description

tags?array<string>

user?Required name of user started this entity

owner?Required name of owner of this entity

project?Required project name

schedule_at?Optional last time the entity was started

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

started_at?Optional last time the entity was started

finished_at?Optional last time the entity was started

wait_time?Optional wait time of the entity

duration?Optional duration of the entity

managed_by?v1ManagedBy

is_managed?Optional flag to tell if this entity is managed by the platform

is_approved?Deprecated flag that was replaced by "pending", and it will be completely dropped after v1.15

pending?v1RunPending

content?Optional content of the entity's spec

raw_content?Optional content of the entity's spec

status?v1Statuses

bookmarked?Optional if this entity was bookmarked

live_state?Current live state

readme?Optional Markdown description/readme

meta_info?

kind?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

runtime?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

inputs?

outputs?

original?

pipeline?

status_conditions?array<>

role?Current user's role in this (org/teams)/project/runs

contributors?array<>

settings?

resources?

graph?

merge?Optional merge flag

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/restart" \  -H "Content-Type: application/json" \  -d '{}'

{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "user": "string",  "owner": "string",  "project": "string",  "schedule_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "wait_time": 0.1,  "duration": 0.1,  "managed_by": "client",  "is_managed": true,  "is_approved": true,  "pending": "approval",  "content": "string",  "raw_content": "string",  "status": "created",  "bookmarked": true,  "live_state": 0,  "readme": "string",  "meta_info": {},  "kind": "job",  "runtime": "job",  "inputs": {},  "outputs": {},  "original": {    "uuid": "string",    "name": "string",    "kind": "copy"  },  "pipeline": {    "uuid": "string",    "name": "string",    "kind": "dag"  },  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "role": "string",  "contributors": [    {}  ],  "settings": {    "namespace": "string",    "agent": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "queue": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "artifacts_store": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "tensorboard": {},    "build": {},    "component": {},    "models": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ],    "artifacts": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ]  },  "resources": {    "cpu": 0.1,    "memory": 0.1,    "gpu": 0.1,    "custom": 0.1,    "cost": 0.1  },  "graph": {},  "merge": true}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Resume run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

run.uuid*string

UUID

Request Body

application/json

Run object

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

name?Optional name

description?Optional description

tags?array<string>

user?Required name of user started this entity

owner?Required name of owner of this entity

project?Required project name

schedule_at?Optional last time the entity was started

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

started_at?Optional last time the entity was started

finished_at?Optional last time the entity was started

wait_time?Optional wait time of the entity

duration?Optional duration of the entity

managed_by?v1ManagedBy

is_managed?Optional flag to tell if this entity is managed by the platform

is_approved?Deprecated flag that was replaced by "pending", and it will be completely dropped after v1.15

pending?v1RunPending

content?Optional content of the entity's spec

raw_content?Optional content of the entity's spec

status?v1Statuses

bookmarked?Optional if this entity was bookmarked

live_state?Current live state

readme?Optional Markdown description/readme

meta_info?

kind?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

runtime?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

inputs?

outputs?

original?

pipeline?

status_conditions?array<>

role?Current user's role in this (org/teams)/project/runs

contributors?array<>

settings?

resources?

graph?

merge?Optional merge flag

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/resume" \  -H "Content-Type: application/json" \  -d '{}'

{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "user": "string",  "owner": "string",  "project": "string",  "schedule_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "wait_time": 0.1,  "duration": 0.1,  "managed_by": "client",  "is_managed": true,  "is_approved": true,  "pending": "approval",  "content": "string",  "raw_content": "string",  "status": "created",  "bookmarked": true,  "live_state": 0,  "readme": "string",  "meta_info": {},  "kind": "job",  "runtime": "job",  "inputs": {},  "outputs": {},  "original": {    "uuid": "string",    "name": "string",    "kind": "copy"  },  "pipeline": {    "uuid": "string",    "name": "string",    "kind": "dag"  },  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "role": "string",  "contributors": [    {}  ],  "settings": {    "namespace": "string",    "agent": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "queue": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "artifacts_store": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "tensorboard": {},    "build": {},    "component": {},    "models": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ],    "artifacts": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ]  },  "resources": {    "cpu": 0.1,    "memory": 0.1,    "gpu": 0.1,    "custom": 0.1,    "cost": 0.1  },  "graph": {},  "merge": true}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Transfer run

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

run.uuid*string

UUID

Request Body

application/json

Run object

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

name?Optional name

description?Optional description

tags?array<string>

user?Required name of user started this entity

owner?Required name of owner of this entity

project?Required project name

schedule_at?Optional last time the entity was started

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

started_at?Optional last time the entity was started

finished_at?Optional last time the entity was started

wait_time?Optional wait time of the entity

duration?Optional duration of the entity

managed_by?v1ManagedBy

is_managed?Optional flag to tell if this entity is managed by the platform

is_approved?Deprecated flag that was replaced by "pending", and it will be completely dropped after v1.15

pending?v1RunPending

content?Optional content of the entity's spec

raw_content?Optional content of the entity's spec

status?v1Statuses

bookmarked?Optional if this entity was bookmarked

live_state?Current live state

readme?Optional Markdown description/readme

meta_info?

kind?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

runtime?Run kind enum Kinds: job, service, dag, matrix, schedule Runtime kinds: job, service, dag, dask, ray, mpijob, tfjob helper kinds: tuner, watchdog, notifier, cleaner, build

inputs?

outputs?

original?

pipeline?

status_conditions?array<>

role?Current user's role in this (org/teams)/project/runs

contributors?array<>

settings?

resources?

graph?

merge?Optional merge flag

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/transfer" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Create bulk run artifacts lineage

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

uuid*string

Uuid identifier of the entity

Request Body

application/json

Run Artifacts

TypeScript Definitions

Use the request body type in TypeScript.

artifacts?array<>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/lineage/artifacts" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run artifacts lineage

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

uuid*string

Uuid identifier of the entity

name*string

Artifact name

Query Parameters

namespace?string

namespace.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/string/string/runs/string/lineage/artifacts/string"

{  "name": "string",  "state": "string",  "kind": "model",  "path": "string",  "connection": "string",  "run": "string",  "summary": {},  "is_input": true,  "meta_info": {}}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete run artifact lineage

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

uuid*string

Uuid identifier of the entity

name*string

Artifact name

Query Parameters

namespace?string

namespace.

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/string/string/runs/string/lineage/artifacts/string"

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Set run edges graph lineage

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project

uuid*string

Run uuid

Request Body

application/json

Run edges graph

TypeScript Definitions

Use the request body type in TypeScript.

edges?array<>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/lineage/edges" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Create new run status

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

uuid*string

Uuid identifier of the entity

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

owner?Owner of the namespace

project?Project where the run will be assigned

uuid?Uuid identifier of the entity

condition?

force?Force flag

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/statuses" \  -H "Content-Type: application/json" \  -d '{}'

{  "uuid": "string",  "status": "created",  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "meta_info": {}}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Internal API to collect run logs

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

namespace*string

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

uuid*string

Uuid identifier of the entity

kind*string

Kind of the entity

Response Body

`application/json`

curl -X POST "https://example.com/internal/v1/string/string/string/runs/string/string/logs"

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get multi runs events

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

entity*string

Entity where the run will be assigned

kind*string

The artifact kind

Query Parameters

names?string

Names query param.

runs?string

Runs query param.

orient?string

Orient query param.

force?boolean

Force query param.

sample?integer

Sample query param.

connection?string

Connection to use.

status?string

Optional status.

Response Body

`application/json`

curl -X GET "https://example.com/streams/v1/string/string/string/runs/multi/events/model"

{  "data": {}}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get multi run importance

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

entity*string

Entity where the run will be assigned

Request Body

application/json

Params/Metrics data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/streams/v1/string/string/string/runs/multi/importance" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {}}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run artifact

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

project*string

Project where the entity will be assigned

uuid*string

Unique integer identifier of the entity

Query Parameters

path?string

Artifact filepath.

stream?boolean

Whether to stream the file.

force?boolean

Whether to force reload.

connection?string

Connection to use.

Response Body

`application/json`

curl -X GET "https://example.com/streams/v1/string/string/string/runs/string/artifact"

"string"

{}

{}

{}

Delete run artifact

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

uuid*string

Uuid identifier of the entity

Query Parameters

path?string

Path query param.

connection?string

Connection to use.

Response Body

`application/json`

curl -X DELETE "https://example.com/streams/v1/string/string/string/runs/string/artifact"

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run artifacts

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

project*string

Project where the entity will be assigned

uuid*string

Unique integer identifier of the entity

Query Parameters

path?string

Artifact filepath.

force?boolean

Whether to force reload.

connection?string

Connection to use.

Response Body

`application/json`

curl -X GET "https://example.com/streams/v1/string/string/string/runs/string/artifacts"

"string"

{}

{}

{}

Delete run artifacts

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

uuid*string

Uuid identifier of the entity

Query Parameters

path?string

Path query param.

connection?string

Connection to use.

Response Body

`application/json`

curl -X DELETE "https://example.com/streams/v1/string/string/string/runs/string/artifacts"

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run artifacts tree

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

uuid*string

Uuid identifier of the entity

Query Parameters

path?string

Path query param.

connection?string

Connection to use.

Response Body

`application/json`

curl -X GET "https://example.com/streams/v1/string/string/string/runs/string/artifacts/tree"

{  "files": {    "property1": 0,    "property2": 0  },  "dirs": [    "string"  ],  "is_done": true}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run events

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

uuid*string

Uuid identifier of the entity

kind*string

The artifact kind

Query Parameters

names?string

Names query param.

orient?string

Orient query param.

force?boolean

Force query param.

sample?integer

Sample query param.

connection?string

Connection to use.

status?string

Optional status.

Response Body

`application/json`

curl -X GET "https://example.com/streams/v1/string/string/string/runs/string/events/model"

{  "data": [    {}  ]}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Inspect an active run full conditions

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

uuid*string

Uuid identifier of the entity

Query Parameters

kind?string

The entity kind.

names?string

Names query param.

tail?boolean

Query param flag to tail the values.

force?boolean

Force query param.

sample?integer

Sample query param.

connection?string

Connection to use.

status?string

Optional status.

Response Body

`application/json`

curl -X GET "https://example.com/streams/v1/string/string/string/runs/string/k8s_inspect"

{}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run logs

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

namespace*string

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

uuid*string

Uuid identifier of the entity

Query Parameters

kind?string

Kind of the entity.

last_time?string

last time.

last_file?string

last file.

force?boolean

Force query param.

connection?string

Connection to use.

Response Body

`application/json`

curl -X GET "https://example.com/streams/v1/string/string/string/runs/string/logs"

{  "logs": [    {      "timestamp": "2019-08-24T14:15:22Z",      "node": "string",      "pod": "string",      "container": "string",      "value": "string"    }  ],  "last_time": "2019-08-24T14:15:22Z",  "last_file": "string",  "files": [    "string"  ]}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Notify run status

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

namespace*string

Na,espace

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

uuid*string

Uuid identifier of the entity

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

namespace?Na,espace

owner?Owner of the namespace

project?Project where the run will be assigned

uuid?Uuid identifier of the entity

name?Optional name of the entity

condition?

connections?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/streams/v1/string/string/string/runs/string/notify" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run resources events

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

project*string

Project where the run will be assigned

uuid*string

Uuid identifier of the entity

Query Parameters

kind?string

The entity kind.

names?string

Names query param.

tail?boolean

Query param flag to tail the values.

force?boolean

Force query param.

sample?integer

Sample query param.

connection?string

Connection to use.

status?string

Optional status.

Response Body

`application/json`

curl -X GET "https://example.com/streams/v1/string/string/string/runs/string/resources"

{  "data": [    {}  ]}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Upload a logs file to a store via run access

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project having access to the store

uuid*string

Unique integer identifier of the entity

Query Parameters

path?string

File path query params.

overwrite?boolean

File path query params.

connection?string

Connection to use.

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

uploadfile*string

The file to upload.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/logs/upload" \  -F uploadfile="string"

Empty

{}

{}

{}

Upload an artifact file to a store via run access

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project having access to the store

uuid*string

Unique integer identifier of the entity

Query Parameters

path?string

File path query params.

overwrite?boolean

File path query params.

connection?string

Connection to use.

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

uploadfile*string

The file to upload.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/string/string/runs/string/artifacts/upload" \  -F uploadfile="string"

Empty

{}

{}

{}

Runs

200application/json

204application/json

403application/json

404application/json

defaultapplication/json

200application/json

204application/json

403application/json

404application/json

defaultapplication/json

200application/json

204application/json

403application/json

404application/json

defaultapplication/json

200

204application/json

403application/json

404application/json

defaultapplication/json

200

204application/json

403application/json

404application/json

defaultapplication/json

200

204application/json

403application/json

404application/json

defaultapplication/json

200

204application/json

403application/json

404application/json

defaultapplication/json

200application/json

204application/json

403application/json

404application/json

defaultapplication/json

200

204application/json

403application/json

404application/json

defaultapplication/json

200application/json

204application/json

403application/json

404application/json

defaultapplication/json

200application/json

204application/json

403application/json

404application/json

defaultapplication/json

200application/json

204application/json

403application/json

404application/json

defaultapplication/json

200application/json

204application/json

403application/json

404application/json

defaultapplication/json

200application/json

204application/json

403application/json

404application/json

defaultapplication/json

200application/json

204application/json

403application/json

404application/json

defaultapplication/json

200application/json

204application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`