Skip to main content

Ayon server (1.0.1)

Download OpenAPI specification:Download

Open VFX and Animation pipeline server

Authentication

Authentication endpoints. Most of the endpoints require authentication. This is done by passing Authorization header with Bearer <token> value.

Login

Login using name/password credentials.

Returns access token and user information. The token is used for authentication in other endpoints. It is valid for 24 hours, but it is extended automatically when the user is active.

Token may be revoked by calling the logout endpoint or using session manager.

Returns 401 response if the credentials are invalid.

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

Username

password
required
string (Password)

Password

Responses

Request samples

Content type
application/json
{
  • "name": "admin",
  • "password": "SecretPassword.123"
}

Response samples

Content type
application/json
{
  • "detail": "Logged in as NAME",
  • "error": "Unauthorized",
  • "token": "TOKEN",
  • "user": {
    }
}

Logout

Log out the current user.

query Parameters
token
string (Token)
header Parameters
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "detail": "Logged out"
}

List Active Sessions

query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Projects

Project is a collection of folders and other entities. Each project has a unique name, which is used as its identifier.

To address an entity within the project, you need to provide both the project name and the entity ID.

Operations

Process multiple operations (create / update / delete) in a single request.

All operations are processed in the order they are provided in the request. If can_fail is set to False, the processing stops on the first error and all previous operations are rolled back. If can_fail is set to True, the processing continues and all operations are committed.

The response contains the list of operations with their success status. In case of failure, the error message is provided for each operation.

This endpoint normally does not return error response, unless there is a problem with the request itself or an unhandled exception. Do not rely on a status code to determine if the operation was successful.

Always check the success field of the response.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
token
string (Token)
header Parameters
x-sender
string (X-Sender)
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
Array of objects (Operations)
canFail
boolean (Canfail)
Default: false

Responses

Request samples

Content type
application/json
{
  • "operations": [
    ],
  • "canFail": false
}

Response samples

Content type
application/json
{
  • "operations": [
    ],
  • "success": true
}

Get Project Anatomy

Retrieve a project anatomy.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "roots": [
    ],
  • "templates": {
    },
  • "attributes": {
    },
  • "folder_types": [
    ],
  • "task_types": [
    ],
  • "link_types": [
    ],
  • "statuses": [
    ],
  • "tags": [
    ]
}

Set Project Anatomy

Set a project anatomy.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
token
string (Token)
header Parameters
x-sender
string (X-Sender)
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
Array of objects (Roots)
Default: [{"name":"work","windows":"C:/projects","linux":"/mnt/share/projects","darwin":"/Volumes/projects"}]

Setup root paths for the project

object (Templates)

Path templates configuration

object (Attributes)

Attributes configuration

Array of objects (Folder types)

Folder types configuration

Array of objects (Task types)

Task types configuration

Array of objects (Link types)

Link types configuration

Array of objects (Statuses)

Statuses configuration

Array of objects (Tags)

Tags configuration

Responses

Request samples

Content type
application/json
{
  • "roots": [
    ],
  • "templates": {
    },
  • "attributes": {
    },
  • "folder_types": [
    ],
  • "task_types": [
    ],
  • "link_types": [
    ],
  • "statuses": [
    ],
  • "tags": [
    ]
}

Response samples

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

List Projects

Return a list of available projects.

query Parameters
page
integer (Page) >= 1
Default: 1
length
integer (Records per page) >= 1
Default: 200

If not provided, the result will not be limited

library
boolean (Show library projects)

If not provided, return projects regardless the flag

active
boolean (Show active projects)

If not provided, return projects regardless the flag

order
string (Attribute to order the list by)
Enum: "name" "createdAt" "updatedAt"
desc
boolean (Sort in descending order)
Default: false
name
string (Filter by name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
Example: name=forest

Limit the result to project with the matching name, or its part. % character may be used as a wildcard

token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "detail": "Showing LENGTH of COUNT projects",
  • "count": 1,
  • "projects": [
    ]
}

Deploy Project

Create a new project using the provided anatomy object.

Main purpose is to take an anatomy object and transform its contents to the project entity (along with additional data such as the project name).

query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
name
required
string (Name)

Project name

code
string (Code)

Project code

required
object (Anatomy)

Project anatomy

library
boolean (Library)
Default: false

Library project

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "anatomy": {
    },
  • "library": false
}

Response samples

Content type
application/json
null

Get Project

Retrieve a project by its name.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "name": "awesome_project",
  • "code": "prj",
  • "library": false,
  • "folderTypes": [
    ],
  • "taskTypes": [
    ],
  • "linkTypes": [
    ],
  • "statuses": [
    ],
  • "tags": [
    ],
  • "config": { },
  • "attrib": {
    },
  • "data": { },
  • "active": true,
  • "ownAttrib": [
    ],
  • "createdAt": "2023-01-01T00:00:00+00:00",
  • "updatedAt": "2023-01-01T00:00:00+00:00"
}

Create Project

Create a new project.

Since project has no ID, and a unique name is used as its identifier, use PUT request with the name provided in the URL to create a new project.

This is different from the rest of the entities, which use POST requests to create new entities with a unique ID.

Important: this endpoint only creates a project entity. It does not handle creating its anatomy and assigning users to the project, so it should be used only in special cases, when you need a granular control over a project creation process. Use Deploy project ([POST] /api/projects) for general usage.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
code
required
string (Project code) ^[a-zA-Z0-9_]*$
library
boolean (Library)
Default: false
folderTypes
Array of any (Folder types)
taskTypes
Array of any (Task types)
Array of objects (Link types)
statuses
Array of any (Statuses)
tags
Array of any (Tags)

List of tags available to set on entities.

config
object (Project config)
Default: {}
object (Project attributes)
data
object (Project auxiliary data)
active
boolean (Project active)
Default: true

Whether the project is active

Responses

Request samples

Content type
application/json
{
  • "code": "prj",
  • "library": false,
  • "folderTypes": [
    ],
  • "taskTypes": [
    ],
  • "linkTypes": [
    ],
  • "statuses": [
    ],
  • "tags": [
    ],
  • "config": { },
  • "attrib": {
    },
  • "data": { },
  • "active": true
}

Response samples

Content type
application/json
null

Delete Project

Delete a given project including all its entities.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

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

Update Project

Patch a project.

Use a PATCH request to partially update a project. For example change the name or a particular key in 'data'.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
token
string (Token)
header Parameters
x-sender
string (X-Sender)
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
code
string (Project code) ^[a-zA-Z0-9_]*$
library
boolean (Library)
Default: false
folderTypes
Array of any (Folder types)
taskTypes
Array of any (Task types)
Array of objects (Link types)
statuses
Array of any (Statuses)
tags
Array of any (Tags)

List of tags available to set on entities.

config
object (Project config)
Default: {}
object (Project attributes)
data
object (Project auxiliary data)
active
boolean (Project active)
Default: true

Whether the project is active

Responses

Request samples

Content type
application/json
{
  • "code": "prj",
  • "library": false,
  • "folderTypes": [
    ],
  • "taskTypes": [
    ],
  • "linkTypes": [
    ],
  • "statuses": [
    ],
  • "tags": [
    ],
  • "config": { },
  • "attrib": {
    },
  • "data": { },
  • "active": true
}

Response samples

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

Get Project Stats

Retrieve a project statistics by its name.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
null

Get Project Roots Overrides

Return overrides for project roots.

This endpoint is used to get overrides for project roots. The result is an a dictionary with site_id as a key and a dictionary with root names as keys and root paths as values.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Set Project Roots Overrides

path Parameters
site_id
required
string (Site Id)
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
null

Folders

Endpoints for managing folders.

Get Folder

Retrieve a folder by its ID.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
folder_id
required
string (Folder ID) = 32 characters ^[0-9a-f]{32}$
Example: af10c8f0e9b111e9b8f90242ac130003
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "id": "c10d5bc73dcab7da4cba0f3e0b3c0aea",
  • "name": "bush",
  • "label": "bush",
  • "folderType": "Asset",
  • "parentId": "c10d5bc73dcab7da4cba0f3e0b3c0aea",
  • "thumbnailId": "c10d5bc73dcab7da4cba0f3e0b3c0aea",
  • "path": "/assets/characters/xenomorph",
  • "attrib": {
    },
  • "data": { },
  • "active": true,
  • "ownAttrib": [
    ],
  • "status": "In progress",
  • "tags": [
    ],
  • "createdAt": "2023-01-01T00:00:00+00:00",
  • "updatedAt": "2023-01-01T00:00:00+00:00"
}

Delete Folder

Delete a folder.

Returns 409 error in there's a published product in the folder or any of its subfolders. Otherwise, deletes the folder and all its subfolders.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
folder_id
required
string (Folder ID) = 32 characters ^[0-9a-f]{32}$
Example: af10c8f0e9b111e9b8f90242ac130003
query Parameters
token
string (Token)
header Parameters
x-sender
string (X-Sender)
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

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

Update Folder

Patch (partially update) a folder.

Once there is a version published, the folder's name and hierarchy cannot be changed.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
folder_id
required
string (Folder ID) = 32 characters ^[0-9a-f]{32}$
Example: af10c8f0e9b111e9b8f90242ac130003
query Parameters
token
string (Token)
header Parameters
x-sender
string (X-Sender)
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
name
string (Folder name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
label
string (Folder label) ^[^';]*$
folderType
string (Folder type)
parentId
string (Parent ID) ^[0-f]{32}$

Parent folder ID in the hierarchy

thumbnailId
string (Thumbnail ID) ^[0-f]{32}$
status
string (Folder status)

Status of the folder

tags
Array of strings (Folder tags)

Tags assigned to the the folder

object (Folder attributes)
data
object (Folder auxiliary data)
active
boolean (Folder active)
Default: true

Whether the folder is active

Responses

Request samples

Content type
application/json
{
  • "name": "bush",
  • "label": "bush",
  • "folderType": "Asset",
  • "parentId": "c10d5bc73dcab7da4cba0f3e0b3c0aea",
  • "thumbnailId": "c10d5bc73dcab7da4cba0f3e0b3c0aea",
  • "status": "In progress",
  • "tags": [
    ],
  • "attrib": {
    },
  • "data": { },
  • "active": true
}

Response samples

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

Create Folder

Create a new folder.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
token
string (Token)
header Parameters
x-sender
string (X-Sender)
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
name
required
string (Folder name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
label
string (Folder label) ^[^';]*$
folderType
string (Folder type)
parentId
string (Parent ID) ^[0-f]{32}$

Parent folder ID in the hierarchy

thumbnailId
string (Thumbnail ID) ^[0-f]{32}$
status
string (Folder status)

Status of the folder

tags
Array of strings (Folder tags)

Tags assigned to the the folder

object (Folder attributes)
data
object (Folder auxiliary data)
active
boolean (Folder active)
Default: true

Whether the folder is active

Responses

Request samples

Content type
application/json
{
  • "name": "bush",
  • "label": "bush",
  • "folderType": "Asset",
  • "parentId": "c10d5bc73dcab7da4cba0f3e0b3c0aea",
  • "thumbnailId": "c10d5bc73dcab7da4cba0f3e0b3c0aea",
  • "status": "In progress",
  • "tags": [
    ],
  • "attrib": {
    },
  • "data": { },
  • "active": true
}

Response samples

Content type
application/json
{
  • "id": "af10c8f0e9b111e9b8f90242ac130003"
}

Get Folder Hierarchy

Return a folder hierarchy of a project.

path Parameters
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
search
string (Search query)
Default: ""
Example: search=forest

Full-text search query used to limit the result

types
string (Type filter)
Default: ""
Example: types=AssetBuild,Shot,Sequence

Comma separated list of folder_types to show

token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "detail": "string",
  • "projectName": "string",
  • "hierarchy": [
    ]
}

Attributes

Endpoints related to attribute configuration.

Warning: data does not reflect the active configuration of the attributes. The server needs to be restarted in order the changes become active.

Get Attribute List

Return a list of attributes and their configuration.

query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

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

Set Attribute List

Set the attribute configuration for all (or ao of) attributes

query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
Array of objects (Attributes configuration)
deleteMissing
boolean (Delete missing)
Default: false

Delete custom attributes not includedin the payload from the database.

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ],
  • "deleteMissing": false
}

Response samples

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

Get Attribute Config

Return the configuration for a single attribute.

path Parameters
attribute_name
required
string (Attribute name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "name": "my_attribute",
  • "position": 12,
  • "scope": [
    ],
  • "builtin": false,
  • "data": {
    }
}

Set Attribute Config

Update attribute configuration

path Parameters
attribute_name
required
string (Attribute name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
position
required
integer (Positon)

Default order

Array of strings or strings (Scope)

List of entity types the attribute is available on

builtin
boolean (Builtin)
Default: false

Is attribute builtin. Built-in attributes cannot be removed.

required
object (AttributeData)

Base API model.

Responses

Request samples

Content type
application/json
{
  • "position": 12,
  • "scope": [
    ],
  • "builtin": false,
  • "data": {
    }
}

Response samples

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

Delete Attribute

path Parameters
attribute_name
required
string (Attribute name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

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

Addon settings

Addon configuration, site and project overrides...

Get Addon Project Settings Schema

Return the JSON schema of the addon settings.

path Parameters
addon_name
required
string (Addon Name)
version
required
string (Version)
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
variant
string (Variant)
Default: "production"
site
string (Site) ^[a-z0-9-]+$
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{ }

Get Addon Project Settings

path Parameters
addon_name
required
string (Addon Name)
version
required
string (Version)
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
variant
string (Variant)
Default: "production"
site
string (Site) ^[a-z0-9-]+$
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{ }

Set Addon Project Settings

Set the studio overrides of the given addon.

path Parameters
addon_name
required
string (Addon Name)
version
required
string (Version)
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
variant
string (Variant)
Default: "production"
site
string (Site) ^[a-z0-9-]+$
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
object (Payload)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "code": 401,
  • "detail": "Not logged in"
}

Get Addon Project Overrides

path Parameters
addon_name
required
string (Addon Name)
version
required
string (Version)
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
variant
string (Variant)
Default: "production"
site
string (Site) ^[a-z0-9-]+$
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
null

Modify Project Overrides

path Parameters
addon_name
required
string (Addon Name)
version
required
string (Version)
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
variant
string (Variant)
Default: "production"
site
string (Site) ^[a-z0-9-]+$
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
action
required
string (Action)
Enum: "delete" "pin"
path
required
Array of strings (Path)

Responses

Request samples

Content type
application/json
{
  • "action": "delete",
  • "path": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 401,
  • "detail": "Not logged in"
}

Delete Addon Project Overrides

path Parameters
addon_name
required
string (Addon Name)
version
required
string (Version)
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
variant
string (Variant)
Default: "production"
site
string (Site) ^[a-z0-9-]+$
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "code": 401,
  • "detail": "Not logged in"
}

Get Raw Addon Project Overrides

path Parameters
addon_name
required
string (Addon Name)
addon_version
required
string (Addon Version)
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
variant
string (Variant)
Default: "production"
site
string (Site) ^[a-z0-9-]+$
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{ }

Set Raw Addon Project Overrides

path Parameters
addon_name
required
string (Addon Name)
addon_version
required
string (Addon Version)
project_name
required
string (Project name) ^[a-zA-Z0-9_]*$
query Parameters
variant
string (Variant)
Default: "production"
site
string (Site) ^[a-z0-9-]+$
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
object (Payload)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "code": 401,
  • "detail": "Not logged in"
}

Get Addon Site Settings Schema

Return the JSON schema of the addon site settings.

path Parameters
addon_name
required
string (Addon Name)
version
required
string (Version)
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{ }

Get Addon Site Settings

Return the JSON schema of the addon site settings.

path Parameters
addon_name
required
string (Addon Name)
version
required
string (Version)
query Parameters
site
required
string (Site)
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{ }

Set Addon Site Settings

path Parameters
addon_name
required
string (Addon Name)
version
required
string (Version)
query Parameters
site
required
string (Site ID) ^[a-z0-9-]+$
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
object (Payload)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "code": 401,
  • "detail": "Not logged in"
}

Get Addon Settings Schema

Return the JSON schema of the addon settings.

path Parameters
addon_name
required
string (Addon Name)
addon_version
required
string (Addon Version)
query Parameters
variant
string (Variant)
Default: "production"
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{ }

Get Addon Studio Settings

Return the settings (including studio overrides) of the given addon.

path Parameters
addon_name
required
string (Addon Name)
addon_version
required
string (Addon Version)
query Parameters
variant
string (Variant)
Default: "production"
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{ }

Set Addon Studio Settings

Set the studio overrides for the given addon.

path Parameters
addon_name
required
string (Addon Name)
addon_version
required
string (Addon Version)
query Parameters
variant
string (Variant)
Default: "production"
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
object (Payload)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "code": 401,
  • "detail": "Not logged in"
}

Get Addon Studio Overrides

path Parameters
addon_name
required
string (Addon Name)
addon_version
required
string (Addon Version)
query Parameters
variant
string (Variant)
Default: "production"
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
null

Modify Studio Overrides

path Parameters
addon_name
required
string (Addon Name)
addon_version
required
string (Addon Version)
query Parameters
variant
string (Variant)
Default: "production"
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
action
required
string (Action)
Enum: "delete" "pin"
path
required
Array of strings (Path)

Responses

Request samples

Content type
application/json
{
  • "action": "delete",
  • "path": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 401,
  • "detail": "Not logged in"
}

Delete Addon Studio Overrides

path Parameters
addon_name
required
string (Addon Name)
addon_version
required
string (Addon Version)
query Parameters
variant
string (Variant)
Default: "production"
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "code": 401,
  • "detail": "Not logged in"
}

Get Raw Addon Studio Overrides

path Parameters
addon_name
required
string (Addon Name)
addon_version
required
string (Addon Version)
query Parameters
variant
string (Variant)
Default: "production"
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{ }

Set Raw Addon Studio Overrides

path Parameters
addon_name
required
string (Addon Name)
addon_version
required
string (Addon Version)
query Parameters
variant
string (Variant)
Default: "production"
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
object (Payload)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "code": 401,
  • "detail": "Not logged in"
}

List Addons

List all available addons.

query Parameters
details
boolean (Show details)
Default: false
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

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

Configure Addons

query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
object (VariantCopyRequest)

Base API model.

addonName
required
string (Addonname)

Addon name

copyFrom
required
string (Copyfrom)
Enum: "production" "staging"

Source variant

copyTo
required
string (Copyto)
Enum: "production" "staging"

Destination variant

Responses

Request samples

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

Response samples

Content type
application/json
null

Get All Addons Settings Deprecated

Return all addon settings for the project.

query Parameters
variant
string (Settings variant)
Default: "production"
Enum: "production" "staging"
project
string (Project) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
site
string (Site) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "settings": {
    },
  • "versions": {
    }
}

Get All Site Settings Deprecated

Return site settings for all enabled addons.

Those are 'global' site settings (from addon.site_settings_model) with no project overrides. When site is not specified, it will return the default settings provided by the model.

query Parameters
variant
string (Settings variant)
Default: "production"
Enum: "production" "staging"
site
string (Site) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "settings": {
    },
  • "versions": {
    }
}

Get All Settings

query Parameters
bundle_name
string (Bundle name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...

Production if not set

project_name
string (Project name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...

Studio settings if not set

site_id
string (Site ID)
variant
string (Variant)
Default: "production"
summary
boolean (Summary)
Default: false

Summary mode

token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "bundleName": "string",
  • "addons": [
    ]
}

Secrets

Sensitive information, like passwords or API keys, can be securely stored in secrets, which are only accessible by administrators and services. This makes them an ideal location for storing this type of data.

For addons needing access to secrets, using the 'secret name' in settings instead of the actual value is recommended. Consequently, updating secrets won't require any changes to the addon configuration.

Get List Of Secrets

Return a list of stored secrets

query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Secret

Return a secret value

path Parameters
secret_name
required
string (Secret name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

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

Save Secret

Create or update a secret value

path Parameters
secret_name
required
string (Secret name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
name
string (Secret name)
value
string (Secret value)

Responses

Request samples

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

Response samples

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

Delete Secret

Delete a secret

path Parameters
secret_name
required
string (Secret name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

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

Access Groups

Get Access Group Schema

Responses

Response samples

Content type
application/json
null

Get Access Groups

Get a list of access group for a given project

path Parameters
project_name
required
string (Project name)
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
[
  • { }
]

Get Access Group

Get an access group definition

path Parameters
access_group_name
required
string (Access group name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
project_name
required
string (Project name)
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "create": {
    },
  • "read": {
    },
  • "update": {
    },
  • "publish": {
    },
  • "delete": {
    },
  • "attrib_read": {
    },
  • "attrib_write": {
    },
  • "endpoints": {
    }
}

Save Access Group

Create or update an access group.

Use _ as a project name to save a global access group.

path Parameters
access_group_name
required
string (Access group name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
project_name
required
string (Project name)
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
object (Restrict folder creation)

Whitelist folders a user can create

object (Restrict folder read)

Whitelist folders a user can read

object (Restrict folder update)

Whitelist folders a user can update

object (Restrict publishing)

Whitelist folders a user can publish to

object (Restrict folder delete)

Whitelist folders a user can delete

object (Restrict attribute read)

Whitelist attributes a user can read

object (Restrict attribute update)

Whitelist attributes a user can write

object (Restrict REST endpoints)

Whitelist REST endpoints a user can access

Responses

Request samples

Content type
application/json
{
  • "create": {
    },
  • "read": {
    },
  • "update": {
    },
  • "publish": {
    },
  • "delete": {
    },
  • "attrib_read": {
    },
  • "attrib_write": {
    },
  • "endpoints": {
    }
}

Response samples

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

Delete Access Group

Delete an access group

path Parameters
access_group_name
required
string (Access group name) ^[a-zA-Z0-9_]([a-zA-Z0-9_\.\-]*[a-zA-Z0-9_])?...
project_name
required
string (Project name)
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

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

Addons

Delete Addon

Delete an addon

path Parameters
addon_name
required
string (Addon Name)
query Parameters
purge
boolean (Purge all data related to the addon)
Default: false
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
null

Delete Addon Version

Delete an addon version

path Parameters
addon_name
required
string (Addon Name)
addon_version
required
string (Addon Version)
query Parameters
purge
boolean (Purge all data related to the addon)
Default: false
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
null

Get Installed Addons List

Get a list of installed addons

query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "restartRequired": true
}

Upload Addon Zip File

Upload an addon zip file and install it

query Parameters
url
string (URL to the addon zip file)
addonName
string (Addon name)
addonVersion
string (Addon version)
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

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

Anatomy

Get Anatomy Schema

Returns the anatomy JSON schema.

The schema is used to display the anatomy preset editor form.

query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{ }

Get Anatomy Presets

Return a list of stored anatomy presets.

query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "version": "string",
  • "presets": [
    ]
}

Get Anatomy Preset

Returns the anatomy preset with the given name.

Use _ character as a preset name to return the default preset.

path Parameters
preset_name
required
string (Preset Name)
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)

Responses

Response samples

Content type
application/json
{
  • "roots": [
    ],
  • "templates": {
    },
  • "attributes": {
    },
  • "folder_types": [
    ],
  • "task_types": [
    ],
  • "link_types": [
    ],
  • "statuses": [
    ],
  • "tags": [
    ]
}

Update Anatomy Preset

Create/update an anatomy preset with the given name.

path Parameters
preset_name
required
string (Preset Name)
query Parameters
token
string (Token)
header Parameters
x-as-user
string (X-As-User) ^[a-zA-Z0-9][a-zA-Z0-9_\.\-]*[a-zA-Z0-9]$
x-api-key
string (X-Api-Key) ^[a-zA-Z0-9\-]*$
authorization
string (Authorization)
Request Body schema: application/json
Array of objects (Roots)
Default: [{"name":"work","windows":"C:/projects","linux":"/mnt/share/projects","darwin":"/Volumes/projects"}]

Setup root paths for the project

object (Templates)

Path templates configuration

object (Attributes)

Attributes configuration

Array of objects (Folder types)

Folder types configuration

Array of objects (Task types)

Task types configuration

Array of objects (Link types)

Link types configuration

Array of objects (Statuses)

Statuses configuration

Array of objects (Tags)

Tags configuration

Responses

Request samples

Content type
application/json
{
  • "roots": [
    ],
  • "templates": {