Projects

List archived projects 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/projects"

{  "count": 0,  "results": [    {      "uuid": "string",      "owner": "string",      "user": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "is_public": true,      "bookmarked": true,      "readme": "string",      "excluded_features": [        "string"      ],      "excluded_runtimes": [        "string"      ],      "archived_deletion_interval": 0,      "settings": {        "connections": [          "string"        ],        "default_presets": [          "string"        ],        "default_presets_ordered": [          "string"        ],        "presets": [          "string"        ],        "queue": "string",        "queues": [          "string"        ],        "agents": [          "string"        ],        "namespaces": [          "string"        ],        "user_accesses": [          {            "user": "string",            "user_data": {              "username": "string",              "is_sa": true            },            "queue": "string",            "default_presets": [              "string"            ],            "default_presets_ordered": [              "string"            ],            "namespace": "string"          }        ],        "teams": [          "string"        ],        "projects": [          "string"        ],        "policy": "string"      },      "role": "string",      "live_state": 0,      "contributors": [        {}      ]    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

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

List bookmarked projects 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/projects"

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

{}

{}

{}

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

Create new project

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Project body

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

owner?Owner/namespace where the project was created

user?Optional name of user created this entity

name?Required name

description?Optional description

tags?array<string>

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

is_public?Optional flag to tell if this project is public

bookmarked?Optional if this entity was bookmarked

readme?Optional Markdown description/readme

excluded_features?array<string>

excluded_runtimes?array<string>

archived_deletion_interval?Optional project archived deletion interval

settings?

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

live_state?Current live state

contributors?array<>

Response Body

`application/json`

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

{  "uuid": "string",  "owner": "string",  "user": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "is_public": true,  "bookmarked": true,  "readme": "string",  "excluded_features": [    "string"  ],  "excluded_runtimes": [    "string"  ],  "archived_deletion_interval": 0,  "settings": {    "connections": [      "string"    ],    "default_presets": [      "string"    ],    "default_presets_ordered": [      "string"    ],    "presets": [      "string"    ],    "queue": "string",    "queues": [      "string"    ],    "agents": [      "string"    ],    "namespaces": [      "string"    ],    "user_accesses": [      {        "user": "string",        "user_data": {          "username": "string",          "is_sa": true        },        "queue": "string",        "default_presets": [          "string"        ],        "default_presets_ordered": [          "string"        ],        "namespace": "string"      }    ],    "teams": [      "string"    ],    "projects": [      "string"    ],    "policy": "string"  },  "role": "string",  "live_state": 0,  "contributors": [    {}  ]}

{}

{}

{}

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

List projects

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

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/projects/list"

{  "count": 0,  "results": [    {      "uuid": "string",      "owner": "string",      "user": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "is_public": true,      "bookmarked": true,      "readme": "string",      "excluded_features": [        "string"      ],      "excluded_runtimes": [        "string"      ],      "archived_deletion_interval": 0,      "settings": {        "connections": [          "string"        ],        "default_presets": [          "string"        ],        "default_presets_ordered": [          "string"        ],        "presets": [          "string"        ],        "queue": "string",        "queues": [          "string"        ],        "agents": [          "string"        ],        "namespaces": [          "string"        ],        "user_accesses": [          {            "user": "string",            "user_data": {              "username": "string",              "is_sa": true            },            "queue": "string",            "default_presets": [              "string"            ],            "default_presets_ordered": [              "string"            ],            "namespace": "string"          }        ],        "teams": [          "string"        ],        "projects": [          "string"        ],        "policy": "string"      },      "role": "string",      "live_state": 0,      "contributors": [        {}      ]    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

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

List project names

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

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/projects/names"

{  "count": 0,  "results": [    {      "uuid": "string",      "owner": "string",      "user": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "is_public": true,      "bookmarked": true,      "readme": "string",      "excluded_features": [        "string"      ],      "excluded_runtimes": [        "string"      ],      "archived_deletion_interval": 0,      "settings": {        "connections": [          "string"        ],        "default_presets": [          "string"        ],        "default_presets_ordered": [          "string"        ],        "presets": [          "string"        ],        "queue": "string",        "queues": [          "string"        ],        "agents": [          "string"        ],        "namespaces": [          "string"        ],        "user_accesses": [          {            "user": "string",            "user_data": {              "username": "string",              "is_sa": true            },            "queue": "string",            "default_presets": [              "string"            ],            "default_presets_ordered": [              "string"            ],            "namespace": "string"          }        ],        "teams": [          "string"        ],        "projects": [          "string"        ],        "policy": "string"      },      "role": "string",      "live_state": 0,      "contributors": [        {}      ]    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

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

List versions

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity name under namespace

kind*string

Version Kind

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/versions/string"

{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "owner": "string",      "user": "string",      "project": "string",      "connection": "string",      "run": "string",      "artifacts": [        "string"      ],      "meta_info": {},      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "stage": "testing",      "kind": "component",      "stage_conditions": [        {          "type": "testing",          "status": "string",          "reason": "string",          "message": "string",          "last_update_time": "2019-08-24T14:15:22Z",          "last_transition_time": "2019-08-24T14:15:22Z",          "meta_info": {}        }      ],      "content": "string",      "readme": "string",      "state": "string",      "role": "string",      "contributors": [        {}      ]    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

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

List versions names

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity name under namespace

kind*string

Version Kind

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/versions/string/names"

{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "owner": "string",      "user": "string",      "project": "string",      "connection": "string",      "run": "string",      "artifacts": [        "string"      ],      "meta_info": {},      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "stage": "testing",      "kind": "component",      "stage_conditions": [        {          "type": "testing",          "status": "string",          "reason": "string",          "message": "string",          "last_update_time": "2019-08-24T14:15:22Z",          "last_transition_time": "2019-08-24T14:15:22Z",          "meta_info": {}        }      ],      "content": "string",      "readme": "string",      "state": "string",      "role": "string",      "contributors": [        {}      ]    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

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

Get version

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

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

kind*string

Version Kind

name*string

Sub-entity name

Response Body

`application/json`

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

{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "owner": "string",  "user": "string",  "project": "string",  "connection": "string",  "run": "string",  "artifacts": [    "string"  ],  "meta_info": {},  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "stage": "testing",  "kind": "component",  "stage_conditions": [    {      "type": "testing",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "content": "string",  "readme": "string",  "state": "string",  "role": "string",  "contributors": [    {}  ]}

{}

{}

{}

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

Delete version

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

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

kind*string

Version Kind

name*string

Sub-entity name

Response Body

`application/json`

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

Empty

{}

{}

{}

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

Get version stages

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

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

kind*string

Version Kind

name*string

Sub-entity name

Response Body

`application/json`

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

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

{}

{}

{}

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

Create new artifact version stage

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity namespace

kind*string

Optional kind, only required for an version entity

name*string

Name of the entity to apply the stage to

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

owner?Owner of the namespace

entity?Entity namespace

kind?Optional kind, only required for an version entity

name?Name of the entity to apply the stage to

condition?

Response Body

`application/json`

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

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

{}

{}

{}

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

Get project

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Component under namespace

Response Body

`application/json`

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

{  "uuid": "string",  "owner": "string",  "user": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "is_public": true,  "bookmarked": true,  "readme": "string",  "excluded_features": [    "string"  ],  "excluded_runtimes": [    "string"  ],  "archived_deletion_interval": 0,  "settings": {    "connections": [      "string"    ],    "default_presets": [      "string"    ],    "default_presets_ordered": [      "string"    ],    "presets": [      "string"    ],    "queue": "string",    "queues": [      "string"    ],    "agents": [      "string"    ],    "namespaces": [      "string"    ],    "user_accesses": [      {        "user": "string",        "user_data": {          "username": "string",          "is_sa": true        },        "queue": "string",        "default_presets": [          "string"        ],        "default_presets_ordered": [          "string"        ],        "namespace": "string"      }    ],    "teams": [      "string"    ],    "projects": [      "string"    ],    "policy": "string"  },  "role": "string",  "live_state": 0,  "contributors": [    {}  ]}

{}

{}

{}

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

Delete project

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Component under namespace

Response Body

`application/json`

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

Empty

{}

{}

{}

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

Get project activities

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/activities"

{  "count": 0,  "results": [    {      "actor": "string",      "owner": "string",      "created_at": "2019-08-24T14:15:22Z",      "event_action": "string",      "event_subject": "string",      "object_name": "string",      "object_uuid": "string",      "object_parent": "string"    }  ],  "previous": "string",  "next": "string"}

{}

{}

{}

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

Archive project

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Component under namespace

Response Body

`application/json`

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

Empty

{}

{}

{}

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

Bookmark project

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Component under namespace

Response Body

`application/json`

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

Empty

{}

{}

{}

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

Enable project CI

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Component under namespace

Response Body

`application/json`

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

Empty

{}

{}

{}

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

Disbale project CI

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Component under namespace

Response Body

`application/json`

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

Empty

{}

{}

{}

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

Restore project

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Component under namespace

Response Body

`application/json`

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

Empty

{}

{}

{}

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

Get Project settings

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Component under namespace

Response Body

`application/json`

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

{  "connections": [    "string"  ],  "default_presets": [    "string"  ],  "default_presets_ordered": [    "string"  ],  "presets": [    "string"  ],  "queue": "string",  "queues": [    "string"  ],  "agents": [    "string"  ],  "namespaces": [    "string"  ],  "user_accesses": [    {      "user": "string",      "user_data": {        "username": "string",        "is_sa": true      },      "queue": "string",      "default_presets": [        "string"      ],      "default_presets_ordered": [        "string"      ],      "namespace": "string"    }  ],  "teams": [    "string"  ],  "projects": [    "string"  ],  "policy": "string"}

{}

{}

{}

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

Get project stats

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

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/stats"

{}

{}

{}

{}

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

Unbookmark project

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Component under namespace

Response Body

`application/json`

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

Empty

{}

{}

{}

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

Patch project

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project.name*string

Required name

Request Body

application/json

Project body

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

owner?Owner/namespace where the project was created

user?Optional name of user created this entity

name?Required name

description?Optional description

tags?array<string>

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

is_public?Optional flag to tell if this project is public

bookmarked?Optional if this entity was bookmarked

readme?Optional Markdown description/readme

excluded_features?array<string>

excluded_runtimes?array<string>

archived_deletion_interval?Optional project archived deletion interval

settings?

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

live_state?Current live state

contributors?array<>

Response Body

`application/json`

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

{  "uuid": "string",  "owner": "string",  "user": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "is_public": true,  "bookmarked": true,  "readme": "string",  "excluded_features": [    "string"  ],  "excluded_runtimes": [    "string"  ],  "archived_deletion_interval": 0,  "settings": {    "connections": [      "string"    ],    "default_presets": [      "string"    ],    "default_presets_ordered": [      "string"    ],    "presets": [      "string"    ],    "queue": "string",    "queues": [      "string"    ],    "agents": [      "string"    ],    "namespaces": [      "string"    ],    "user_accesses": [      {        "user": "string",        "user_data": {          "username": "string",          "is_sa": true        },        "queue": "string",        "default_presets": [          "string"        ],        "default_presets_ordered": [          "string"        ],        "namespace": "string"      }    ],    "teams": [      "string"    ],    "projects": [      "string"    ],    "policy": "string"  },  "role": "string",  "live_state": 0,  "contributors": [    {}  ]}

{}

{}

{}

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

Update project

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project.name*string

Required name

Request Body

application/json

Project body

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

owner?Owner/namespace where the project was created

user?Optional name of user created this entity

name?Required name

description?Optional description

tags?array<string>

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

is_public?Optional flag to tell if this project is public

bookmarked?Optional if this entity was bookmarked

readme?Optional Markdown description/readme

excluded_features?array<string>

excluded_runtimes?array<string>

archived_deletion_interval?Optional project archived deletion interval

settings?

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

live_state?Current live state

contributors?array<>

Response Body

`application/json`

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

{  "uuid": "string",  "owner": "string",  "user": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "is_public": true,  "bookmarked": true,  "readme": "string",  "excluded_features": [    "string"  ],  "excluded_runtimes": [    "string"  ],  "archived_deletion_interval": 0,  "settings": {    "connections": [      "string"    ],    "default_presets": [      "string"    ],    "default_presets_ordered": [      "string"    ],    "presets": [      "string"    ],    "queue": "string",    "queues": [      "string"    ],    "agents": [      "string"    ],    "namespaces": [      "string"    ],    "user_accesses": [      {        "user": "string",        "user_data": {          "username": "string",          "is_sa": true        },        "queue": "string",        "default_presets": [          "string"        ],        "default_presets_ordered": [          "string"        ],        "namespace": "string"      }    ],    "teams": [      "string"    ],    "projects": [      "string"    ],    "policy": "string"  },  "role": "string",  "live_state": 0,  "contributors": [    {}  ]}

{}

{}

{}

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

Patch project settings

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project name

Request Body

application/json

Project settings body

TypeScript Definitions

Use the request body type in TypeScript.

connections?array<string>

default_presets?array<string>

default_presets_ordered?array<string>

presets?array<string>

queue?Default Queue

queues?array<string>

agents?array<string>

namespaces?array<string>

user_accesses?array<>

teams?array<string>

projects?array<string>

policy?Attached policy

Response Body

`application/json`

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

{  "connections": [    "string"  ],  "default_presets": [    "string"  ],  "default_presets_ordered": [    "string"  ],  "presets": [    "string"  ],  "queue": "string",  "queues": [    "string"  ],  "agents": [    "string"  ],  "namespaces": [    "string"  ],  "user_accesses": [    {      "user": "string",      "user_data": {        "username": "string",        "is_sa": true      },      "queue": "string",      "default_presets": [        "string"      ],      "default_presets_ordered": [        "string"      ],      "namespace": "string"    }  ],  "teams": [    "string"  ],  "projects": [    "string"  ],  "policy": "string"}

{}

{}

{}

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

Update project settings

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project name

Request Body

application/json

Project settings body

TypeScript Definitions

Use the request body type in TypeScript.

connections?array<string>

default_presets?array<string>

default_presets_ordered?array<string>

presets?array<string>

queue?Default Queue

queues?array<string>

agents?array<string>

namespaces?array<string>

user_accesses?array<>

teams?array<string>

projects?array<string>

policy?Attached policy

Response Body

`application/json`

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

{  "connections": [    "string"  ],  "default_presets": [    "string"  ],  "default_presets_ordered": [    "string"  ],  "presets": [    "string"  ],  "queue": "string",  "queues": [    "string"  ],  "agents": [    "string"  ],  "namespaces": [    "string"  ],  "user_accesses": [    {      "user": "string",      "user_data": {        "username": "string",        "is_sa": true      },      "queue": "string",      "default_presets": [        "string"      ],      "default_presets_ordered": [        "string"      ],      "namespace": "string"    }  ],  "teams": [    "string"  ],  "projects": [    "string"  ],  "policy": "string"}

{}

{}

{}

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

Create version

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project name

version.kind*string

Optional kind to tell the kind of this version

Request Body

application/json

Project version body

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

name?Optional component name, should be a valid fully qualified value: name[:version]

description?Optional description

tags?array<string>

owner?Owner of this entity

user?Required name of user started this entity

project?Project name

connection?Connection name

run?Run lineage

artifacts?array<string>

meta_info?

Extra information related to the run, lineage, artifacts, ...

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

stage?v1Stages

kind?v1ProjectVersionKind

stage_conditions?array<>

content?The metadata/content body

readme?Optional Markdown description/readme

state?The version state read-only

role?Current user's role in this (org/teams)/hub/version

contributors?array<>

Response Body

`application/json`

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

{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "owner": "string",  "user": "string",  "project": "string",  "connection": "string",  "run": "string",  "artifacts": [    "string"  ],  "meta_info": {},  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "stage": "testing",  "kind": "component",  "stage_conditions": [    {      "type": "testing",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "content": "string",  "readme": "string",  "state": "string",  "role": "string",  "contributors": [    {}  ]}

{}

{}

{}

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

Patch version

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project name

version.kind*string

Optional kind to tell the kind of this version

version.name*string

Optional component name, should be a valid fully qualified value: name[:version]

Request Body

application/json

Project version body

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

name?Optional component name, should be a valid fully qualified value: name[:version]

description?Optional description

tags?array<string>

owner?Owner of this entity

user?Required name of user started this entity

project?Project name

connection?Connection name

run?Run lineage

artifacts?array<string>

meta_info?

Extra information related to the run, lineage, artifacts, ...

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

stage?v1Stages

kind?v1ProjectVersionKind

stage_conditions?array<>

content?The metadata/content body

readme?Optional Markdown description/readme

state?The version state read-only

role?Current user's role in this (org/teams)/hub/version

contributors?array<>

Response Body

`application/json`

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

{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "owner": "string",  "user": "string",  "project": "string",  "connection": "string",  "run": "string",  "artifacts": [    "string"  ],  "meta_info": {},  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "stage": "testing",  "kind": "component",  "stage_conditions": [    {      "type": "testing",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "content": "string",  "readme": "string",  "state": "string",  "role": "string",  "contributors": [    {}  ]}

{}

{}

{}

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

Update version

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project name

version.kind*string

Optional kind to tell the kind of this version

version.name*string

Optional component name, should be a valid fully qualified value: name[:version]

Request Body

application/json

Project version body

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

name?Optional component name, should be a valid fully qualified value: name[:version]

description?Optional description

tags?array<string>

owner?Owner of this entity

user?Required name of user started this entity

project?Project name

connection?Connection name

run?Run lineage

artifacts?array<string>

meta_info?

Extra information related to the run, lineage, artifacts, ...

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

stage?v1Stages

kind?v1ProjectVersionKind

stage_conditions?array<>

content?The metadata/content body

readme?Optional Markdown description/readme

state?The version state read-only

role?Current user's role in this (org/teams)/hub/version

contributors?array<>

Response Body

`application/json`

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

{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "owner": "string",  "user": "string",  "project": "string",  "connection": "string",  "run": "string",  "artifacts": [    "string"  ],  "meta_info": {},  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "stage": "testing",  "kind": "component",  "stage_conditions": [    {      "type": "testing",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "content": "string",  "readme": "string",  "state": "string",  "role": "string",  "contributors": [    {}  ]}

{}

{}

{}

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

Transfer version

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project name

version.kind*string

Optional kind to tell the kind of this version

version.name*string

Optional component name, should be a valid fully qualified value: name[:version]

Request Body

application/json

Project version body

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

name?Optional component name, should be a valid fully qualified value: name[:version]

description?Optional description

tags?array<string>

owner?Owner of this entity

user?Required name of user started this entity

project?Project name

connection?Connection name

run?Run lineage

artifacts?array<string>

meta_info?

Extra information related to the run, lineage, artifacts, ...

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

stage?v1Stages

kind?v1ProjectVersionKind

stage_conditions?array<>

content?The metadata/content body

readme?Optional Markdown description/readme

state?The version state read-only

role?Current user's role in this (org/teams)/hub/version

contributors?array<>

Response Body

`application/json`

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

Empty

{}

{}

{}

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

Create new project via team space

Authorization

ApiKey

Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

team*string

Team

Request Body

application/json

Project body

TypeScript Definitions

Use the request body type in TypeScript.

uuid?UUID

owner?Owner/namespace where the project was created

user?Optional name of user created this entity

name?Required name

description?Optional description

tags?array<string>

created_at?Optional time when the entity was created

updated_at?Optional last time the entity was updated

is_public?Optional flag to tell if this project is public

bookmarked?Optional if this entity was bookmarked

readme?Optional Markdown description/readme

excluded_features?array<string>

excluded_runtimes?array<string>

archived_deletion_interval?Optional project archived deletion interval

settings?

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

live_state?Current live state

contributors?array<>

Response Body

`application/json`

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

{  "uuid": "string",  "owner": "string",  "user": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "is_public": true,  "bookmarked": true,  "readme": "string",  "excluded_features": [    "string"  ],  "excluded_runtimes": [    "string"  ],  "archived_deletion_interval": 0,  "settings": {    "connections": [      "string"    ],    "default_presets": [      "string"    ],    "default_presets_ordered": [      "string"    ],    "presets": [      "string"    ],    "queue": "string",    "queues": [      "string"    ],    "agents": [      "string"    ],    "namespaces": [      "string"    ],    "user_accesses": [      {        "user": "string",        "user_data": {          "username": "string",          "is_sa": true        },        "queue": "string",        "default_presets": [          "string"        ],        "default_presets_ordered": [          "string"        ],        "namespace": "string"      }    ],    "teams": [      "string"    ],    "projects": [      "string"    ],    "policy": "string"  },  "role": "string",  "live_state": 0,  "contributors": [    {}  ]}

{}

{}

{}

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

Upload artifact to a store via project 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.

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/artifacts/string/upload" \  -F uploadfile="string"

Empty

{}

{}

{}

Projects

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

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

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

200

`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`