Qarnot Logo
API docs by Redocly

Qarnot Computing: Compute API (v1.0)

Download OpenAPI specification:Download

Compute API to access Qarnot services

HardwareConstraints

List HardwareConstraints (Auth)

List all available hardware constraints for the authenticated user

Authorizations:
Authorization
path Parameters
version
required
string
query Parameters
Limit
integer <int32>
Example: Limit=49

Limit of the number of displayed results Maximum value is .

Offset
integer <int32>
Example: Offset=0

Number of results discarded

header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/hardware-constraints?Limit=49&Offset=0

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "offset": 0,
  • "limit": 0,
  • "total": 0
}

List Cpu constraints (Auth)

Search cpu constraints for the authenticated user

Authorizations:
Authorization
path Parameters
version
required
string
query Parameters
cpuModel
required
string

Name of the cpu model

header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/hardware-constraints/cpu-model-constraints/search

Response samples

Content type
application/json
[
  • {
    }
]

Jobs

List Jobs (Auth)

List all jobs belonging to the authenticated user.

Authorizations:
Authorization
path Parameters
version
required
string
query Parameters
tag
Array of strings
Example: tag=t1&tag=t2,t3

Optional Tag filter

header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/jobs?tag=t1&tag=t2,t3

Response samples

Content type
application/json
[
  • {
    }
]

Create Job (Auth)

Create a new job. Location header is set to the newly created job location, {snapshot,results}{White,Black}list are optional. If a list of jobs is provided, the response will conserve the submit order and a status will be provided for each job submitted(Location header won't be changed in this case).

Authorizations:
Authorization
path Parameters
version
required
string
Request Body schema:

Configuration of the new job (some missing or invalid fields)

name
required
string non-empty

Name of the job

Should be less than 2048 characters.

shortname
string or null

Unique name of the job (its Uuid by default)

Should be unique. Available characters (all alphanumeric + hyphen): a-z, A-Z, 0-9 and -. Should start with a letter or number and should not end with an hyphen (-).

poolUuid
string or null <uuid>

Uuid of the job's pool if any

Should be the uuid of an open pool.

useDependencies
boolean or null

Whether the job's tasks can be dependent from each other, i.e. they be run in a specific order and should wait fot the previous task to end before starting

tags
Array of strings or null

Custom tags to use as filtering

Should be less than 10.

The tags values should not be null and should be less than 512 characters.

maxWallTime
string or null <date-span>

Maximum real living time of the job

autoDeleteOnCompletion
boolean or null

Whether the job should be deleted if completed and the job quota is reached

completionTimeToLive
string or null <date-span>

Limit for the job execution time

Responses

Request samples

Content type
{
  • "name": "my job",
  • "shortname": "first-job",
  • "poolUuid": "62e80aae-d20a-4608-b873-ec8bff991733",
  • "useDependencies": true,
  • "tags": [
    ],
  • "maxWallTime": "10:00:00",
  • "autoDeleteOnCompletion": true,
  • "completionTimeToLive": "00:30:00"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

List Filtered Jobs (Auth)

List all jobs belonging to the authenticated user and matching the filters.

Authorizations:
Authorization
path Parameters
version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Request Body schema:

Filter configuration

object (Select)

The results fields that should be displayed

(Node (object or null)) or (UnitValueLeaf (object or null)) or (MultipleValueLeaf (object or null))

Filter to apply on data

maximumResults
integer or null <int32>

Maximum number of results displayed

Responses

Request samples

Content type
{
  • "select": {
    },
  • "filter": {
    },
  • "maximumResults": 1
}

Response samples

Content type
application/json
[
  • {
    }
]

Paginate Jobs (Auth)

List all jobs belonging to the authenticated user with pagination. Available operators for filters are: And / Or / Equal / NotEqual / LessThanOrEqual / LessThan / GreaterThanOrEqual / Like / In / NotIn Available sorting fields: creationDate / name / state.

Authorizations:
Authorization
path Parameters
version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Request Body schema:

Page configuration

token
string or null

Token of the response.

(Node (object or null)) or (UnitValueLeaf (object or null)) or (MultipleValueLeaf (object or null))

Filter to apply on data.

maximumResults
integer or null <int32>

Number maximal of results.

orderBy
string or null

Sorting property.

orderType
string or null

Type of ordering.

ASC or DESC

Responses

Request samples

Content type
{
  • "token": "token",
  • "filter": {
    },
  • "maximumResults": 1,
  • "orderBy": "state",
  • "orderType": "ASC"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "count": 1,
  • "total": 1,
  • "isTruncated": true,
  • "nextToken": "string"
}

Terminate Job (Auth)

Terminate a job

Authorizations:
Authorization
path Parameters
jobUuid
required
string

Requested job UUID

version
required
string

Responses

Request samples 

curl -X POST -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/jobs/{jobUuid}/terminate

Delete Job (Auth)

Delete a job (terminate it if it's still running)

Authorizations:
Authorization
path Parameters
jobuuid
required
string

Requested job UUID

version
required
string
query Parameters
force
boolean
Default: false

Whether the job should be deleted despite having running tasks

Responses

Request samples 

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/jobs/{jobuuid}

Job Info (Auth)

Get information of the specified job

Authorizations:
Authorization
path Parameters
jobuuid
required
string

Requested job UUID

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/jobs/{jobuuid}

Response samples

Content type
application/json
{
  • "uuid": "12345678-1234-1234-1234-123456789012",
  • "name": "my job",
  • "shortname": "first-job",
  • "poolUuid": "62e80aae-d20a-4608-b873-ec8bff991733",
  • "state": "FullyExecuting",
  • "previousState": "PartiallyExecuting",
  • "useDependencies": true,
  • "stateTransitionTime": "2021-05-01T19:00:00Z",
  • "previousStateTransitionTime": "2021-05-01T17:56:29Z",
  • "creationDate": "2021-05-01T15:04:27Z",
  • "lastModified": "2021-05-01T19:01:29Z",
  • "maxWallTime": "1.03:16:50.5000000",
  • "tags": [
    ],
  • "autoDeleteOnCompletion": true,
  • "completionTimeToLive": "00:30:00"
}

List Job's Tasks (Auth)

List tasks in the specified jobb

Authorizations:
Authorization
path Parameters
jobuuid
required
string

Requested job UUID

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/jobs/{jobuuid}/tasks

Response samples

Content type
application/json
Example
{
  • "resourceBuckets": [
    ],
  • "advancedResourceBuckets": null,
  • "resultBucket": "my-output-bucket",
  • "resultsCacheTTLSec": null,
  • "completedInstances": null,
  • "status": {
    },
  • "snapshotInterval": 0,
  • "resultsCount": 1,
  • "constants": [
    ],
  • "secretsAccessRights": null,
  • "tags": null,
  • "snapshotWhitelist": "white.*",
  • "snapshotBlacklist": ".*black.*",
  • "uploadResultsOnCancellation": null,
  • "dependencies": null,
  • "autoDeleteOnCompletion": false,
  • "completionTimeToLive": "00:00:00",
  • "hardwareConstraints": null,
  • "labels": null,
  • "schedulingType": "flex",
  • "privileges": null,
  • "retrySettings": null,
  • "uuid": "52c10b2d-0687-41e1-985e-7279f6dd543a",
  • "name": "my blend",
  • "shortname": "blend-task-1",
  • "profile": "blender",
  • "poolUuid": null,
  • "jobUuid": null,
  • "progress": 0,
  • "runningInstanceCount": 0,
  • "runningCoreCount": 0,
  • "clusterInfo": null,
  • "executionTime": null,
  • "wallTime": null,
  • "state": "Success",
  • "previousState": null,
  • "totalInstanceCount": 0,
  • "instanceCount": 4,
  • "maxRetriesPerInstance": 0,
  • "stateTransitionTime": "0001-01-01T00:00:00Z",
  • "previousStateTransitionTime": "0001-01-01T00:00:00Z",
  • "lastModified": "0001-01-01T00:00:00Z",
  • "creationDate": "2025-04-16T16:01:28Z",
  • "endDate": "0001-01-01T00:00:00Z",
  • "waitForPoolResourcesSynchronization": true
}

Main

Check the availability of the API and the valid authentication of the user (Auth)

Authorizations:
Authorization
path Parameters
version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}

Pools

List Pool summaries (Auth)

List all pool summaries belonging to the authenticated user

Authorizations:
Authorization
path Parameters
version
required
string
query Parameters
tag
Array of strings
Example: tag=t1&tag=t2,t3

Optional tag Filter.

header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/summaries?tag=t1&tag=t2,t3

Response samples

Content type
application/json
[
  • {
    }
]

Paginate Pools Summaries (Auth)

Search in all pools belonging to the authenticated user

  • The available operators are: And / Or /
  • Equal / NotEqual / LessThanOrEqual / LessThan / GreaterThanOrEqual / Like / In / NotIn Available sorting fields: creationDate / executionTime / name / state
Authorizations:
Authorization
path Parameters
version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Request Body schema:

Configuration of the page

token
string or null

Token of the response.

(Node (object or null)) or (UnitValueLeaf (object or null)) or (MultipleValueLeaf (object or null))

Filter to apply on data.

maximumResults
integer or null <int32>

Number maximal of results.

orderBy
string or null

Sorting property.

orderType
string or null

Type of ordering.

ASC or DESC

Responses

Request samples

Content type
{
  • "token": "token",
  • "filter": {
    },
  • "maximumResults": 1,
  • "orderBy": "state",
  • "orderType": "ASC"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "count": 1,
  • "total": 1,
  • "isTruncated": true,
  • "nextToken": "string"
}

List Pools (Auth)

List all pools belonging to the authenticated user

Authorizations:
Authorization
path Parameters
version
required
string
query Parameters
tag
Array of strings
Example: tag=t1&tag=t2,t3

Optional tag Filter.

header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools?tag=t1&tag=t2,t3

Response samples

Content type
application/json
[
  • {
    }
]

Create Pool (Auth)

Create one new pool. Location header is set to the newly created pool location

Authorizations:
Authorization
path Parameters
version
required
string
Request Body schema:

Configuration of the pool to create

name
required
string non-empty

Name of the pool

shortname
string or null

Unique name of the pool (its Uuid by default)

profile
required
string non-empty

Profile used by the tasks in the pool

instanceCount
integer or null <int32>

Number of pool instances

object (ElasticPropertyInput)

Elastic configuration for pool with a flexible size

Obsolete, use scaling configuration instead

object (ScalingInput)

How a pool will be scaled dynamically

Array of objects or null (KeyValue)

List of constants for the pool. They are used to configure the profiles and can be overridden to change its parameters. New constants can also be added to use during the Pool execution.

Allowed characters for the constants' keys: a-z, A-Z, 0-9, _, -, . The constants' keys and values should not be null.

Maximum number of constants is 50. Maximum length of the key and value: 2048 characters.

For secret constants with write-only rights, use the prefix 'QARNOT_SECRET__'

Array of objects or null (ForcedConstant)

List of constants to be overriden for the pool.

This is expected to be used in a development context and requires specific permissions.

The same restrictions that apply to regular constants also apply here.

Array of HardwareConstraint (object) or MinimumCoreHardware (object) or MaximumCoreHardware (object) or MinimumRamHardware (object) or MaximumRamHardware (object) or SpecificHardware (object) or MinimumRamCoreRatioHardware (object) or MaximumRamCoreRatioHardware (object) or SSDHardware (object) or NoSSDHardware (object) or NoGpuHardware (object) or GpuHardware (object) or CpuModelHardware (object) or null

Constraints for the hardware used by the pool

object (SecretsAccessRights)

Describe secrets the task or pool will have access to when running.

tags
Array of strings or null

Custom tags used for filtering

Maximum number of tags: 10.

The tags values should not be null and should be less than 512 characters.

resourceBuckets
Array of strings or null

List of the pool's resources buckets names

Array of objects or null (ResourcesBucket)

(Override ResourceBuckets) List of resources buckets names, with custom prefix

The buckets should already exist in the user storage account.

Should not be set with ResourceBuckets.

The use of either ResourceBuckets or AdvancedResourceBuckets is required.

Maximum number of buckets: 100.

object (PoolPreparationTaskInput)

Represents a task executed on a pool, before any tasks.

autoDeleteOnCompletion
boolean or null

Whether the pool should be deleted if completed and the pool quota is reached

completionTimeToLive
string or null <date-span>

Task life tie limit

taskDefaultWaitForPoolResourcesSynchronization
boolean or null

Default value of WaitForPoolResourcesSynchronization for tasks in the pool: Whether the pool's tasks should by default wait for the pool resources synchronization before starting.

object or null

Pool labels : arbitrary key / value pairs attached to the pool in order to find it more easily. They do not affect the execution of the pool.

schedulingType
string (SchedulingClass)
Enum: "flex" "onDemand" "reserved"

Type of scheduling used when dispatching the tasks

targetedReservedMachineKey
string or null

The key of the reserved machine the pool should be dispatch on. To use with "reserved" SchedulingType

defaultResourcesCacheTTLSec
integer or null <int32>

The default TTL value for all the pool resources cache. TTL is 7776000s by default.

object (Privileges)

List of privileges that can be granted for task execution

object (RetrySettings)

Configuration for instance or task retry

Responses

Request samples

Content type
{
  • "name": "my blend",
  • "shortname": "first-pool",
  • "profile": "blender",
  • "instanceCount": 4,
  • "elasticProperty": {
    },
  • "scaling": {
    },
  • "constants": [
    ],
  • "forcedConstants": [
    ],
  • "hardwareConstraints": [
    ],
  • "secretsAccessRights": {
    },
  • "tags": [
    ],
  • "resourceBuckets": [
    ],
  • "advancedResourceBuckets": [
    ],
  • "preparationTask": {
    },
  • "autoDeleteOnCompletion": true,
  • "completionTimeToLive": "10:00:00",
  • "taskDefaultWaitForPoolResourcesSynchronization": true,
  • "labels": {
    },
  • "schedulingType": "flex",
  • "targetedReservedMachineKey": "my-reserved-machine",
  • "defaultResourcesCacheTTLSec": 2592000,
  • "privileges": {
    },
  • "defaultRetrySettings": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Search Pools (Auth)

Search in all pools belonging to the authenticated user.

Use the Select part of the search to provide a query to get only some pools, use the filter part to only retrieve the selected fields.

  • The available operators are: And / Or /
  • Equal / NotEqual / LessThanOrEqual / LessThan / GreaterThanOrEqual / Like / In / NotIn
Authorizations:
Authorization
path Parameters
version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Request Body schema:

Configuration of the filter

object (Select)

The results fields that should be displayed

(Node (object or null)) or (UnitValueLeaf (object or null)) or (MultipleValueLeaf (object or null))

Filter to apply on data

maximumResults
integer or null <int32>

Maximum number of results displayed

Responses

Request samples

Content type
{
  • "select": {
    },
  • "filter": {
    },
  • "maximumResults": 1
}

Response samples

Content type
application/json
[
  • {
    }
]

Paginate Pools (Auth)

Search in all pools belonging to the authenticated user

  • The available operators are: And / Or /
  • Equal / NotEqual / LessThanOrEqual / LessThan / GreaterThanOrEqual / Like / In / NotIn Available sorting fields: creationDate / executionTime / name / state
Authorizations:
Authorization
path Parameters
version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Request Body schema:

Configuration of the page

token
string or null

Token of the response.

(Node (object or null)) or (UnitValueLeaf (object or null)) or (MultipleValueLeaf (object or null))

Filter to apply on data.

maximumResults
integer or null <int32>

Number maximal of results.

orderBy
string or null

Sorting property.

orderType
string or null

Type of ordering.

ASC or DESC

Responses

Request samples

Content type
{
  • "token": "token",
  • "filter": {
    },
  • "maximumResults": 1,
  • "orderBy": "state",
  • "orderType": "ASC"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "count": 1,
  • "total": 1,
  • "isTruncated": true,
  • "nextToken": "string"
}

Clone pool (Auth)

Cloning a pool with the possibility to change the value of some fields.

Authorizations:
Authorization
path Parameters
pooluuid
required
string

Requested pool UUID

version
required
string
Request Body schema:

Configuration of the new pool that will differ from the cloned pool

name
string or null

Given Name of the cloned pool. Same as the original by default.

Should be less than 2048 characters.

profile
string or null

Profile used by the tasks in the cloned pool

shortname
string or null

Unique name of the pool (its Uuid by default)

instanceCount
integer or null <int32>

Number of pool instances

object (ElasticPropertyInput)

Elastic configuration for pool with a flexible size

Obsolete, use scaling configuration instead

object (ScalingInput)

How a pool will be scaled dynamically

Array of objects or null (KeyValue)

List of constants for the pool. They are used to configure the profiles and can be overridden to change its parameters. New constants can also be added to use during the Pool execution.

Allowed characters for the constants' keys: a-z, A-Z, 0-9, _, -, . The constants' keys and values should not be null.

Maximum number of constants is 50. Maximum length of the key and value: 2048 characters.

For secret constants with write-only rights, use the prefix 'QARNOT_SECRET__'

Array of objects or null (ForcedConstant)

List of constants to be overriden for the pool.

This is expected to be used in a development context and requires specific permissions.

The same restrictions that apply to regular constants also apply here.

Array of HardwareConstraint (object) or MinimumCoreHardware (object) or MaximumCoreHardware (object) or MinimumRamHardware (object) or MaximumRamHardware (object) or SpecificHardware (object) or MinimumRamCoreRatioHardware (object) or MaximumRamCoreRatioHardware (object) or SSDHardware (object) or NoSSDHardware (object) or NoGpuHardware (object) or GpuHardware (object) or CpuModelHardware (object) or null

Constraints for the hardware used by the pool

object (SecretsAccessRights)

Describe secrets the task or pool will have access to when running.

tags
Array of strings or null

Custom tags used for filtering

Maximum number of tags: 10.

The tags values should not be null and should be less than 512 characters.

resourceBuckets
Array of strings or null

List of the pool's resources buckets names

Array of objects or null (ResourcesBucket)

(Override ResourceBuckets) List of resources buckets names, with custom prefix

The buckets should already exist in the user storage account.

Should not be set with ResourceBuckets.

The use of either ResourceBuckets or AdvancedResourceBuckets is required.

Maximum number of buckets: 100.

object (PoolPreparationTaskInput)

Represents a task executed on a pool, before any tasks.

autoDeleteOnCompletion
boolean or null

Whether the pool should be deleted if completed and the pool quota is reached

completionTimeToLive
string or null <date-span>

Task life tie limit

taskDefaultWaitForPoolResourcesSynchronization
boolean or null

Default value of WaitForPoolResourcesSynchronization for tasks in the pool: Whether the pool's tasks should by default wait for the pool resources synchronization before starting.

object or null

Pool labels : arbitrary key / value pairs attached to the pool in order to find it more easily. They do not affect the execution of the pool.

schedulingType
string (SchedulingClass)
Enum: "flex" "onDemand" "reserved"

Type of scheduling used when dispatching the tasks

targetedReservedMachineKey
string or null

The key of the reserved machine the pool should be dispatch on. To use with "reserved" SchedulingType

defaultResourcesCacheTTLSec
integer or null <int32>

The default TTL value for all the pool resources cache. TTL is 7776000s by default.

object (Privileges)

List of privileges that can be granted for task execution

object (RetrySettings)

Configuration for instance or task retry

Responses

Request samples

Content type
{
  • "name": "my blend",
  • "profile": "blender",
  • "shortname": "first-pool",
  • "instanceCount": 4,
  • "elasticProperty": {
    },
  • "scaling": {
    },
  • "constants": [
    ],
  • "forcedConstants": [
    ],
  • "hardwareConstraints": [
    ],
  • "secretsAccessRights": {
    },
  • "tags": [
    ],
  • "resourceBuckets": [
    ],
  • "advancedResourceBuckets": [
    ],
  • "preparationTask": {
    },
  • "autoDeleteOnCompletion": true,
  • "completionTimeToLive": "10:00:00",
  • "taskDefaultWaitForPoolResourcesSynchronization": true,
  • "labels": {
    },
  • "schedulingType": "flex",
  • "targetedReservedMachineKey": "my-reserved-machine",
  • "defaultResourcesCacheTTLSec": 2592000,
  • "privileges": {
    },
  • "defaultRetrySettings": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Close Pool (Auth)

Close a pool

Authorizations:
Authorization
path Parameters
pooluuid
required
string

Requested pool UUID

version
required
string

Responses

Request samples 

curl -X POST -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{pooluuid}/close

Delete Pool (Auth)

Delete a Pool

Authorizations:
Authorization
path Parameters
pooluuid
required
string

Requested pool UUID

version
required
string

Responses

Request samples 

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{pooluuid}

Pool information (Auth)

Get information of the specified pool

Authorizations:
Authorization
path Parameters
pooluuid
required
string

Requested pool UUID

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{pooluuid}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "elasticProperty": {
    },
  • "scaling": {
    },
  • "preparationTask": {
    },
  • "constants": [
    ],
  • "secretsAccessRights": {
    },
  • "tags": [
    ],
  • "resourceBuckets": [
    ],
  • "advancedResourceBuckets": [
    ],
  • "status": {
    },
  • "totalSlotCapacity": 10,
  • "poolUsage": 0.5,
  • "hardwareConstraints": [
    ],
  • "schedulingType": "flex",
  • "targetedReservedMachineKey": "string",
  • "autoDeleteOnCompletion": false,
  • "completionTimeToLive": "30:00:00",
  • "labels": {
    },
  • "privileges": {
    },
  • "defaultRetrySettings": {
    },
  • "uuid": "62e80aae-d20a-4608-b873-ec8bff991733",
  • "name": "my-pool",
  • "shortname": "62e80aae-d20a-4608-b873-ec8bff991733",
  • "profile": "blender",
  • "state": "FullyExecuting",
  • "previousState": "PartiallyExecuting",
  • "instanceCount": 2,
  • "targetRunningInstanceCount": 2,
  • "stateTransitionTime": "2021-04-25T12:34:56Z",
  • "previousStateTransitionTime": "2021-04-25T12:00:19Z",
  • "creationDate": "2021-04-25T11:50:19Z",
  • "lastModified": "2021-04-25T12:45:10Z\"",
  • "endDate": "2019-08-24T14:15:22Z",
  • "runningInstanceCount": 1,
  • "runningCoreCount": 16,
  • "queuedOrRunningTaskInstancesCount": 2,
  • "executionTime": "10:00:00",
  • "wallTime": "10:02:17",
  • "taskDefaultWaitForPoolResourcesSynchronization": false
}

Update pool's resources (Auth)

Trigger resources update on compute nodes. Compute nodes will see new files uploaded to the bucket since the last resources synchronization (either at node provisioning, or from an earlier call to this method) and get an updated version of files that were modified in the bucket.

NOTE: Files that were deleted from the bucket since the last synchronization WILL NOT be deleted from compute nodes.

Authorizations:
Authorization
path Parameters
pooluuid
required
string

Requested pool UUID

version
required
string

Responses

Request samples 

curl -X PATCH -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{pooluuid}

Update pool (Auth)

Updating a pool

Authorizations:
Authorization
path Parameters
pooluuid
required
string

Requested pool UUID

version
required
string
Request Body schema:

New configuration of the pool

Array of objects or null (KeyValue)

List of new constants for the pool

tags
Array of strings or null

List of new tags for the pool

object (ElasticPropertyInput)

Elastic configuration for pool with a flexible size

Obsolete, use scaling configuration instead

object (ScalingInput)

How a pool will be scaled dynamically

Responses

Request samples

Content type
{
  • "constants": [
    ],
  • "tags": [
    ],
  • "elasticProperty": {
    },
  • "scaling": {
    }
}

List pool's Jobs (Auth)

List jobs in the specified pool

Authorizations:
Authorization
path Parameters
pooluuid
required
string

Requested pool UUID

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{pooluuid}/jobs

Response samples

Content type
application/json
[
  • {
    }
]

List pool's Tasks (Auth)

List tasks in the specified pool

Authorizations:
Authorization
path Parameters
pooluuid
required
string

Requested pool UUID

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{pooluuid}/tasks

Response samples

Content type
application/json
Example
{
  • "resourceBuckets": [
    ],
  • "advancedResourceBuckets": null,
  • "resultBucket": "my-output-bucket",
  • "resultsCacheTTLSec": null,
  • "completedInstances": null,
  • "status": {
    },
  • "snapshotInterval": 0,
  • "resultsCount": 1,
  • "constants": [
    ],
  • "secretsAccessRights": null,
  • "tags": null,
  • "snapshotWhitelist": "white.*",
  • "snapshotBlacklist": ".*black.*",
  • "uploadResultsOnCancellation": null,
  • "dependencies": null,
  • "autoDeleteOnCompletion": false,
  • "completionTimeToLive": "00:00:00",
  • "hardwareConstraints": null,
  • "labels": null,
  • "schedulingType": "flex",
  • "privileges": null,
  • "retrySettings": null,
  • "uuid": "52c10b2d-0687-41e1-985e-7279f6dd543a",
  • "name": "my blend",
  • "shortname": "blend-task-1",
  • "profile": "blender",
  • "poolUuid": null,
  • "jobUuid": null,
  • "progress": 0,
  • "runningInstanceCount": 0,
  • "runningCoreCount": 0,
  • "clusterInfo": null,
  • "executionTime": null,
  • "wallTime": null,
  • "state": "Success",
  • "previousState": null,
  • "totalInstanceCount": 0,
  • "instanceCount": 4,
  • "maxRetriesPerInstance": 0,
  • "stateTransitionTime": "0001-01-01T00:00:00Z",
  • "previousStateTransitionTime": "0001-01-01T00:00:00Z",
  • "lastModified": "0001-01-01T00:00:00Z",
  • "creationDate": "2025-04-16T16:01:28Z",
  • "endDate": "0001-01-01T00:00:00Z",
  • "waitForPoolResourcesSynchronization": true
}

Pool Std Out (Auth)

Standard output of the pool (can be rotated).

Authorizations:
Authorization
path Parameters
poolUuid
required
string

Requested pool UUID

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{poolUuid}/stdout

Last Pool Std Out (Auth)

Standard output of the pool (can be rotated) since last access.

Authorizations:
Authorization
path Parameters
poolUuid
required
string

Requested pool UUID

version
required
string

Responses

Request samples 

curl -X POST -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{poolUuid}/stdout

Pool Instance Std Out (Auth)

Get standard output of a specific pool instance (can be rotated).

Authorizations:
Authorization
path Parameters
poolUuid
required
string

Requested pool UUID

instanceId
required
integer <int32>

Id of the instance

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{poolUuid}/stdout/{instanceId}

Last Pool Instance Std Out (Auth)

Get standard output of a specific pool instance (can be rotated).

Authorizations:
Authorization
path Parameters
poolUuid
required
string

Requested pool UUID

instanceId
required
integer <int32>

Id of the instance

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X POST -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{poolUuid}/stdout/{instanceId}

Pool Std Err (Auth)

Error output of the pool (can be rotated).

Authorizations:
Authorization
path Parameters
poolUuid
required
string

Requested pool UUID

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{poolUuid}/stderr

Last Pool Std Err (Auth)

Error output of the pool (can be rotated) since last access.

Authorizations:
Authorization
path Parameters
poolUuid
required
string

Requested pool UUID

version
required
string

Responses

Request samples 

curl -X POST -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{poolUuid}/stderr

Pool Instance Std Err (Auth)

Get Error output of a specific pool instance (can be rotated).

Authorizations:
Authorization
path Parameters
poolUuid
required
string

Requested pool UUID

instanceId
required
integer <int32>

Id of the instance

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{poolUuid}/stderr/{instanceId}

Last Pool Instance Std Err (Auth)

Get Error output of a specific pool instance (can be rotated).

Authorizations:
Authorization
path Parameters
poolUuid
required
string

Requested pool UUID

instanceId
required
integer <int32>

Id of the instance

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X POST -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{poolUuid}/stderr/{instanceId}

Get pool scaling details (Auth)

Authorizations:
Authorization
path Parameters
poolUuid
required
string

UUID of the pool for which to get the scaling details

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/pools/{poolUuid}/scaling

Response samples

Content type
application/json
{
  • "policies": [
    ],
  • "activePolicyName": "the-active-policy"
}

Update pool scaling details (Auth)

Authorizations:
Authorization
path Parameters
poolUuid
required
string

UUID of the pool we want to update

version
required
string
Request Body schema:

New scaling details specification

Array of FixedScalingPolicy (object) or ManagedTasksQueueScalingPolicy (object) or null

List of individual scaling policies

Responses

Request samples

Content type
{
  • "policies": [
    ]
}

Response samples

Content type
application/json
{ }

Get pool Carbon Facts.

Authorizations:
Authorization
path Parameters
poolId
required
string <uuid>

Uuid of the pool.

query Parameters
comparisonDataCenter
string

Name of the datacenter used for the comparison.

Responses

Response samples

Content type
No sample

PoolScalingSanityChecks

Check Scaling sanity (Auth)

Verify if a given Scaling specification is a valid one

Authorizations:
Authorization
path Parameters
version
required
string
Request Body schema:

The scaling specification to check

Array of FixedScalingPolicy (object) or ManagedTasksQueueScalingPolicy (object) or null

List of individual scaling policies

Responses

Request samples

Content type
{
  • "policies": [
    ]
}

Response samples

Content type
application/json
{ }

Profiles

List profiles (Auth)

List available profiles

Authorizations:
Authorization
path Parameters
version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/profiles

Response samples

Content type
application/json
[
  • "string"
]

Profile details (Auth)

List profile details

Authorizations:
Authorization
path Parameters
name
required
string

Name of the profile

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/profiles/{name}

Response samples

Content type
application/json
{
  • "name": "blender-2.76",
  • "constants": [
    ],
  • "licenses": [
    ]
}

Settings

Public Settings

Authorizations:
Authorization
path Parameters
version
required
string

Responses

Request samples 

curl -X GET -H "Content-Type: application/json"   https://localhost/v{version}/settings

Response samples

Content type
application/json
{}

Tasks

List user's tasks. (Auth)

List all tasks belonging to the authenticated user.

Authorizations:
Authorization
path Parameters
version
required
string
query Parameters
tag
Array of strings
Example: tag=t1&tag=t2,t3

Optional tag Filter.

header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks?tag=t1&tag=t2,t3

Response samples

Content type
application/json
Example
{
  • "resourceBuckets": [
    ],
  • "advancedResourceBuckets": null,
  • "resultBucket": "my-output-bucket",
  • "resultsCacheTTLSec": null,
  • "completedInstances": null,
  • "status": {
    },
  • "snapshotInterval": 0,
  • "resultsCount": 1,
  • "constants": [
    ],
  • "secretsAccessRights": null,
  • "tags": null,
  • "snapshotWhitelist": "white.*",
  • "snapshotBlacklist": ".*black.*",
  • "uploadResultsOnCancellation": null,
  • "dependencies": null,
  • "autoDeleteOnCompletion": false,
  • "completionTimeToLive": "00:00:00",
  • "hardwareConstraints": null,
  • "labels": null,
  • "schedulingType": "flex",
  • "privileges": null,
  • "retrySettings": null,
  • "uuid": "52c10b2d-0687-41e1-985e-7279f6dd543a",
  • "name": "my blend",
  • "shortname": "blend-task-1",
  • "profile": "blender",
  • "poolUuid": null,
  • "jobUuid": null,
  • "progress": 0,
  • "runningInstanceCount": 0,
  • "runningCoreCount": 0,
  • "clusterInfo": null,
  • "executionTime": null,
  • "wallTime": null,
  • "state": "Success",
  • "previousState": null,
  • "totalInstanceCount": 0,
  • "instanceCount": 4,
  • "maxRetriesPerInstance": 0,
  • "stateTransitionTime": "0001-01-01T00:00:00Z",
  • "previousStateTransitionTime": "0001-01-01T00:00:00Z",
  • "lastModified": "0001-01-01T00:00:00Z",
  • "creationDate": "2025-04-16T16:01:28Z",
  • "endDate": "0001-01-01T00:00:00Z",
  • "waitForPoolResourcesSynchronization": true
}

Create task (Auth)

Create one or list of new task(s). Location header is set to the newly created task location.

If a list of tasks is provided, the response will conserve the submit order and a status will be provided for each task submitted (Location header won't be changed in this case).

Authorizations:
Authorization
path Parameters
version
required
string
Request Body schema:

Task or list of tasks to create

One of
Array
name
required
string non-empty

Given Name of the task.

Should be less than 2048 characters.

shortname
string or null

Shortname of the task (default is its Uuid).

Should be unique.

Available characters (all alphanumeric + hyphen): a-z, A-Z, 0-9 and -. Should start with a letter or number and should not end with an hyphen (-).

profile
string or null

Profile used by the task

Should be one of the available profiles for the user.

Should not be set if the task is using a pool

poolUuid
string or null <uuid>

Uuid of the task's pool.

Should be the uuid of an open pool.

Should not be set if the task part of a job. If the job uses a pool, the task will automatically inherit it.

jobUuid
string or null <uuid>

Uuid of the task's job.

Should be the uuid of an active job.

instanceCount
integer or null <int32>

Number of task instances.

For a more complex definition of instance ids, use AdvancedRanges instead.

The use of one of InstanceCount or AdvancedRanges is required.

maxRetriesPerInstance
integer or null <int32>
Deprecated

Maximum number of retries per instance.

Should not be set with RetrySettings.MaxPerInstanceRetries.

Prefer the use of RetrySettings.MaxPerInstanceRetries field

advancedRanges
string or null

Range of task instances, represented by a comma-separated list of specific id values or continuous ranges defined by hyphens (-).

(Optional - override InstanceCount) Specify an advanced range instead of a InstanceCount.

The use of one of InstanceCount or AdvancedRanges is required.

resourceBuckets
Array of strings or null

Names of the buckets containing resources for the task.

The buckets should already exist in the user storage account.

Should not be set with AdvancedResourceBuckets.

The use of either ResourceBuckets or AdvancedResourceBuckets is required.

Maximum number of buckets: 100.

Array of objects or null (ResourcesBucket)

Names of the buckets containing resources for the task, with custom prefix.

The buckets should already exist in the user storage account.

Should not be set with ResourceBuckets.

The use of either ResourceBuckets or AdvancedResourceBuckets is required.

Maximum number of buckets: 100.

resultBucket
string or null

Name of the bucket containing results of the task.

If the bucket does not exist in the user storage account, it will be created.

Array of objects or null (KeyValue)

List of constants for the task.

They are used to configure the profiles and can be overridden to change its parameters. New constants can also be added to use during the Task execution.

Allowed characters for the constants' keys: a-z, A-Z, 0-9, _, -, . The constants' keys and values should not be null.

Maximum number of constants is 150. Maximum length of the key and value: 2048 characters.

For secret constants with write-only rights, use the prefix 'QARNOT_SECRET__'

Array of objects or null (ForcedConstant)

List of constants to be overriden for the task.

This is expected to be used in a development context and requires specific permissions.

The same restrictions that apply to regular constants also apply here.

Array of HardwareConstraint (object) or MinimumCoreHardware (object) or MaximumCoreHardware (object) or MinimumRamHardware (object) or MaximumRamHardware (object) or SpecificHardware (object) or MinimumRamCoreRatioHardware (object) or MaximumRamCoreRatioHardware (object) or SSDHardware (object) or NoSSDHardware (object) or NoGpuHardware (object) or GpuHardware (object) or CpuModelHardware (object) or null

Constraints applied to hardware for executing the task.

Cannot set new hardware constraints for a task in a pool.

object (SecretsAccessRights)

Describe secrets the task or pool will have access to when running.

tags
Array of strings or null

(Optional) List of tags

Should be less than 10.

The tags values should not be null and should be less than 512 characters.

snapshotInterval
integer or null <int32>
Deprecated

Snapshot interval.

Cannot be set at task creation (reset to 0). Use periodic snapshot endpoint to set the snapshot interval

snapshotWhitelist
string or null

(Optional) Regex of whitelisted files for snapshots

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

snapshotBlacklist
string or null

(Optional) Regex of blacklisted files for snapshots

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

snapshotBucket
string or null

Name of the snapshot bucket

snapshotBucketPrefix
string or null

Prefix for the snapshot bucket

resultsWhitelist
string or null

(Optional) Regex of whitelisted files for results

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

resultsBlacklist
string or null

(Optional) Regex of blacklisted files for results

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

resultsBucket
string or null

Name of the buckets used for results

resultsBucketPrefix
string or null

Prefix to add to bucket for results

object (DependencyInput)

Initial task dependency

autoDeleteOnCompletion
boolean or null

Whether the task should be deleted if completed and the task quota is reached

completionTimeToLive
string or null <date-span>

Task life time limit

waitForPoolResourcesSynchronization
boolean or null

For in-pool tasks, whether to consider pool resources synchronization as a barrier for execution

uploadResultsOnCancellation
boolean or null

Whether the results should be upload if the task is cancelled

object or null

Task labels : arbitrary key / value pairs attached to the task in order to find it more easily.

They do not affect the execution of the task.

schedulingType
string (SchedulingClass)
Enum: "flex" "onDemand" "reserved"

Type of scheduling used when dispatching the tasks

targetedReservedMachineKey
string or null

The key of the reserved machine the task should be dispatch on. To use with "reserved" SchedulingType

defaultResourcesCacheTTLSec
integer or null <int32>

The default TTL value for all the task resources cache. TTL is 7776000s by default.

resultsCacheTTLSec
integer or null <int32>

The TTL value for the task results cache.

object (Privileges)

List of privileges that can be granted for task execution

object (RetrySettings)

Configuration for instance or task retry

Responses

Request samples

Content type
Example
{
  • "name": "my blend",
  • "shortname": "blend-task-1",
  • "profile": "blender",
  • "instanceCount": 4,
  • "resourceBuckets": [
    ],
  • "advancedResourceBuckets": [ ],
  • "resultBucket": "my-output-bucket",
  • "constants": [
    ],
  • "forcedConstants": [ ],
  • "constraints": [ ],
  • "hardwareConstraints": [ ],
  • "secretsAccessRights": {
    },
  • "tags": [
    ],
  • "snapshotWhitelist": "white.*",
  • "snapshotBlacklist": ".*black.*",
  • "snapshotBucket": "customBucket",
  • "snapshotBucketPrefix": "somePrefix-",
  • "labels": { },
  • "privileges": {
    },
  • "retrySettings": {
    }
}

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

List user's tasks summaries. (Auth)

List all tasks summaries belonging to the authenticated user.

Authorizations:
Authorization
path Parameters
version
required
string
query Parameters
tag
Array of strings
Example: tag=t1&tag=t2,t3

Optional tag Filter.

header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/summaries?tag=t1&tag=t2,t3

Response samples

Content type
application/json
[
  • {
    }
]

Paginate Task summaries (Auth)

Authorizations:
Authorization
path Parameters
version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Request Body schema:

Pagination configuration and Search details.

token
string or null

Token of the response.

(Node (object or null)) or (UnitValueLeaf (object or null)) or (MultipleValueLeaf (object or null))

Filter to apply on data.

maximumResults
integer or null <int32>

Number maximal of results.

orderBy
string or null

Sorting property.

orderType
string or null

Type of ordering.

ASC or DESC

Responses

Request samples

Content type
{
  • "token": "token",
  • "filter": {
    },
  • "maximumResults": 1,
  • "orderBy": "state",
  • "orderType": "ASC"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "count": 1,
  • "total": 1,
  • "isTruncated": true,
  • "nextToken": "string"
}

Search Tasks (Auth)

Complex search in all tasks belonging to the authenticated user.

Use the Select part of the search to provide a query to get only some tasks, use the filter part to only retrieve the selected fields.

  • The available operators are: And / Or /

  • Equal / NotEqual / LessThanOrEqual / LessThan / GreaterThanOrEqual / Like / In / NotIn

  • Available sorting fields: creationDate / executionTime / name / state

Authorizations:
Authorization
path Parameters
version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Request Body schema:

Details of the request filter

object (Select)

The results fields that should be displayed

(Node (object or null)) or (UnitValueLeaf (object or null)) or (MultipleValueLeaf (object or null))

Filter to apply on data

maximumResults
integer or null <int32>

Maximum number of results displayed

Responses

Request samples

Content type
{
  • "select": {
    },
  • "filter": {
    },
  • "maximumResults": 1
}

Response samples

Content type
application/json
[
  • {
    }
]

Paginate Tasks (Auth)

Authorizations:
Authorization
path Parameters
version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Request Body schema:

Pagination configuration and Search details.

token
string or null

Token of the response.

(Node (object or null)) or (UnitValueLeaf (object or null)) or (MultipleValueLeaf (object or null))

Filter to apply on data.

maximumResults
integer or null <int32>

Number maximal of results.

orderBy
string or null

Sorting property.

orderType
string or null

Type of ordering.

ASC or DESC

Responses

Request samples

Content type
{
  • "token": "token",
  • "filter": {
    },
  • "maximumResults": 1,
  • "orderBy": "state",
  • "orderType": "ASC"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "count": 1,
  • "total": 1,
  • "isTruncated": true,
  • "nextToken": "string"
}

Task Periodic snapshot (Auth)

Start a periodic snapshot of the task with the specified time interval (can be clamped by the API).

Setting an interval of 0 will stop the snapshot process. An optional Whitelist and an optional Blacklist can be provided to filter the files accepting the snapshots. Their value is updated and override any value previously provided. If filters have been previously provided (from task creation or periodic snapshot), they are used by default if the body of the request is null.

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string
Request Body schema:

configuration of the periodic snapshot

interval
integer <int32>

Time interval (in sec) between each periodic snapshot.

whitelist
string or null

Whitelist filter.

blacklist
string or null

Blacklist filter.

bucket
string or null

Bucket name.

bucketPrefix
string or null

Bucket prefix.

Responses

Request samples

Content type
{
  • "interval": 30,
  • "whitelist": ".*white.*",
  • "blacklist": ".*black.*",
  • "bucket": "customBucket",
  • "bucketPrefix": "prefix-"
}

Unique task snapshot (Auth)

Request only one snapshot of the task.

An optional Whitelist and an optional Blacklist can be provided to filter the files accepting the snapshots. If periodic snapshots have been called for the same task the filters are overridden only for this unique snapshot. If filters have been previously provided (from task creation or periodic snapshot), they are used by default if the body of the request is null.

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string
Request Body schema:

configuration of the snapshot

whitelist
string or null

Whitelist filter.

blacklist
string or null

Blacklist filter.

bucket
string or null

Bucket name.

bucketPrefix
string or null

Bucket prefix.

Responses

Request samples

Content type
{
  • "whitelist": ".*white.*",
  • "blacklist": ".*black.*",
  • "bucket": "customBucket",
  • "bucketPrefix": "prefix-"
}

Retry task (Auth)

Retrying a task's failed instances with the possibility to change the value of some fields.

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string
Request Body schema:

New task configuration. Will update these fields in the new created task.

name
string or null

Given Name of the cloned task. Same as the original by default.

Should be less than 2048 characters.

resourceBuckets
Array of strings or null

Names of the buckets containing resources for the task.

The buckets should already exist in the user storage account.

If AdvancedResourceBuckets is set its value will be used instead.

Maximum number of buckets: 100.

Array of objects or null (ResourcesBucket)

Names of the buckets containing resources for the task, with custom prefix.

The buckets should already exist in the user storage account.

Will override the value of ResourceBuckets.

Maximum number of buckets: 100.

maxRetriesPerInstance
integer or null <int32>
Deprecated

Maximum number of retries per instance.

If RetrySettings.MaxPerInstanceRetries is set, it will be used instead.

Prefer the use of RetrySettings.MaxPerInstanceRetries field

shortname
string or null

Shortname of the task (default is its Uuid).

Should be unique.

Available characters (all alphanumeric + hyphen): a-z, A-Z, 0-9 and -. Should start with a letter or number and should not end with an hyphen (-).

profile
string or null

Profile used by the task

Should be one of the available profiles for the user.

Should not be set if the task is using a pool

jobUuid
string or null <uuid>

Uuid of the task's job.

Should be the uuid of an active job.

resultBucket
string or null

Name of the bucket containing results of the task.

If the bucket does not exist in the user storage account, it will be created.

Array of objects or null (KeyValue)

List of constants for the task.

They are used to configure the profiles and can be overridden to change its parameters. New constants can also be added to use during the Task execution.

Allowed characters for the constants' keys: a-z, A-Z, 0-9, _, -, . The constants' keys and values should not be null.

Maximum number of constants is 150. Maximum length of the key and value: 2048 characters.

For secret constants with write-only rights, use the prefix 'QARNOT_SECRET__'

Array of objects or null (ForcedConstant)

List of constants to be overriden for the task.

This is expected to be used in a development context and requires specific permissions.

The same restrictions that apply to regular constants also apply here.

Array of HardwareConstraint (object) or MinimumCoreHardware (object) or MaximumCoreHardware (object) or MinimumRamHardware (object) or MaximumRamHardware (object) or SpecificHardware (object) or MinimumRamCoreRatioHardware (object) or MaximumRamCoreRatioHardware (object) or SSDHardware (object) or NoSSDHardware (object) or NoGpuHardware (object) or GpuHardware (object) or CpuModelHardware (object) or null

Constraints applied to hardware for executing the task.

Cannot set new hardware constraints for a task in a pool.

object (SecretsAccessRights)

Describe secrets the task or pool will have access to when running.

tags
Array of strings or null

(Optional) List of tags

Should be less than 10.

The tags values should not be null and should be less than 512 characters.

snapshotInterval
integer or null <int32>
Deprecated

Snapshot interval.

Cannot be set at task creation (reset to 0). Use periodic snapshot endpoint to set the snapshot interval

snapshotWhitelist
string or null

(Optional) Regex of whitelisted files for snapshots

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

snapshotBlacklist
string or null

(Optional) Regex of blacklisted files for snapshots

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

snapshotBucket
string or null

Name of the snapshot bucket

snapshotBucketPrefix
string or null

Prefix for the snapshot bucket

resultsWhitelist
string or null

(Optional) Regex of whitelisted files for results

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

resultsBlacklist
string or null

(Optional) Regex of blacklisted files for results

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

resultsBucket
string or null

Name of the buckets used for results

resultsBucketPrefix
string or null

Prefix to add to bucket for results

object (DependencyInput)

Initial task dependency

autoDeleteOnCompletion
boolean or null

Whether the task should be deleted if completed and the task quota is reached

completionTimeToLive
string or null <date-span>

Task life time limit

waitForPoolResourcesSynchronization
boolean or null

For in-pool tasks, whether to consider pool resources synchronization as a barrier for execution

uploadResultsOnCancellation
boolean or null

Whether the results should be upload if the task is cancelled

object or null

Task labels : arbitrary key / value pairs attached to the task in order to find it more easily.

They do not affect the execution of the task.

schedulingType
string (SchedulingClass)
Enum: "flex" "onDemand" "reserved"

Type of scheduling used when dispatching the tasks

targetedReservedMachineKey
string or null

The key of the reserved machine the task should be dispatch on. To use with "reserved" SchedulingType

defaultResourcesCacheTTLSec
integer or null <int32>

The default TTL value for all the task resources cache. TTL is 7776000s by default.

resultsCacheTTLSec
integer or null <int32>

The TTL value for the task results cache.

object (Privileges)

List of privileges that can be granted for task execution

object (RetrySettings)

Configuration for instance or task retry

Responses

Request samples

Content type
{
  • "name": "my blend",
  • "resourceBuckets": [
    ],
  • "advancedResourceBuckets": [
    ],
  • "maxRetriesPerInstance": 1,
  • "shortname": "blend-task-1",
  • "profile": "blender",
  • "jobUuid": "12345678-1234-1234-1234-123456789012",
  • "resultBucket": "mybucket",
  • "constants": [
    ],
  • "forcedConstants": [
    ],
  • "hardwareConstraints": [
    ],
  • "secretsAccessRights": {
    },
  • "tags": [
    ],
  • "snapshotInterval": 0,
  • "snapshotWhitelist": ".*wanted.*",
  • "snapshotBlacklist": ".*forbid.*",
  • "snapshotBucket": "snapshots",
  • "snapshotBucketPrefix": "prefix",
  • "resultsWhitelist": ".*wanted.*",
  • "resultsBlacklist": ".*forbid.*",
  • "resultsBucket": "results",
  • "resultsBucketPrefix": "prefix",
  • "dependencies": {
    },
  • "autoDeleteOnCompletion": false,
  • "completionTimeToLive": "10:00:00",
  • "waitForPoolResourcesSynchronization": 16,
  • "uploadResultsOnCancellation": false,
  • "labels": {
    },
  • "schedulingType": "flex",
  • "targetedReservedMachineKey": "string",
  • "defaultResourcesCacheTTLSec": 0,
  • "resultsCacheTTLSec": 0,
  • "privileges": {
    },
  • "retrySettings": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Recover task (Auth)

Recovering a task's failed and cancelled instances with the possibility to change the value of some fields.

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string
Request Body schema:

New task configuration. Will update these fields in the new created task.

name
string or null

Given Name of the cloned task. Same as the original by default.

Should be less than 2048 characters.

resourceBuckets
Array of strings or null

Names of the buckets containing resources for the task.

The buckets should already exist in the user storage account.

If AdvancedResourceBuckets is set its value will be used instead.

Maximum number of buckets: 100.

Array of objects or null (ResourcesBucket)

Names of the buckets containing resources for the task, with custom prefix.

The buckets should already exist in the user storage account.

Will override the value of ResourceBuckets.

Maximum number of buckets: 100.

maxRetriesPerInstance
integer or null <int32>
Deprecated

Maximum number of retries per instance.

If RetrySettings.MaxPerInstanceRetries is set, it will be used instead.

Prefer the use of RetrySettings.MaxPerInstanceRetries field

shortname
string or null

Shortname of the task (default is its Uuid).

Should be unique.

Available characters (all alphanumeric + hyphen): a-z, A-Z, 0-9 and -. Should start with a letter or number and should not end with an hyphen (-).

profile
string or null

Profile used by the task

Should be one of the available profiles for the user.

Should not be set if the task is using a pool

jobUuid
string or null <uuid>

Uuid of the task's job.

Should be the uuid of an active job.

resultBucket
string or null

Name of the bucket containing results of the task.

If the bucket does not exist in the user storage account, it will be created.

Array of objects or null (KeyValue)

List of constants for the task.

They are used to configure the profiles and can be overridden to change its parameters. New constants can also be added to use during the Task execution.

Allowed characters for the constants' keys: a-z, A-Z, 0-9, _, -, . The constants' keys and values should not be null.

Maximum number of constants is 150. Maximum length of the key and value: 2048 characters.

For secret constants with write-only rights, use the prefix 'QARNOT_SECRET__'

Array of objects or null (ForcedConstant)

List of constants to be overriden for the task.

This is expected to be used in a development context and requires specific permissions.

The same restrictions that apply to regular constants also apply here.

Array of HardwareConstraint (object) or MinimumCoreHardware (object) or MaximumCoreHardware (object) or MinimumRamHardware (object) or MaximumRamHardware (object) or SpecificHardware (object) or MinimumRamCoreRatioHardware (object) or MaximumRamCoreRatioHardware (object) or SSDHardware (object) or NoSSDHardware (object) or NoGpuHardware (object) or GpuHardware (object) or CpuModelHardware (object) or null

Constraints applied to hardware for executing the task.

Cannot set new hardware constraints for a task in a pool.

object (SecretsAccessRights)

Describe secrets the task or pool will have access to when running.

tags
Array of strings or null

(Optional) List of tags

Should be less than 10.

The tags values should not be null and should be less than 512 characters.

snapshotInterval
integer or null <int32>
Deprecated

Snapshot interval.

Cannot be set at task creation (reset to 0). Use periodic snapshot endpoint to set the snapshot interval

snapshotWhitelist
string or null

(Optional) Regex of whitelisted files for snapshots

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

snapshotBlacklist
string or null

(Optional) Regex of blacklisted files for snapshots

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

snapshotBucket
string or null

Name of the snapshot bucket

snapshotBucketPrefix
string or null

Prefix for the snapshot bucket

resultsWhitelist
string or null

(Optional) Regex of whitelisted files for results

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

resultsBlacklist
string or null

(Optional) Regex of blacklisted files for results

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

resultsBucket
string or null

Name of the buckets used for results

resultsBucketPrefix
string or null

Prefix to add to bucket for results

object (DependencyInput)

Initial task dependency

autoDeleteOnCompletion
boolean or null

Whether the task should be deleted if completed and the task quota is reached

completionTimeToLive
string or null <date-span>

Task life time limit

waitForPoolResourcesSynchronization
boolean or null

For in-pool tasks, whether to consider pool resources synchronization as a barrier for execution

uploadResultsOnCancellation
boolean or null

Whether the results should be upload if the task is cancelled

object or null

Task labels : arbitrary key / value pairs attached to the task in order to find it more easily.

They do not affect the execution of the task.

schedulingType
string (SchedulingClass)
Enum: "flex" "onDemand" "reserved"

Type of scheduling used when dispatching the tasks

targetedReservedMachineKey
string or null

The key of the reserved machine the task should be dispatch on. To use with "reserved" SchedulingType

defaultResourcesCacheTTLSec
integer or null <int32>

The default TTL value for all the task resources cache. TTL is 7776000s by default.

resultsCacheTTLSec
integer or null <int32>

The TTL value for the task results cache.

object (Privileges)

List of privileges that can be granted for task execution

object (RetrySettings)

Configuration for instance or task retry

Responses

Request samples

Content type
{
  • "name": "my blend",
  • "resourceBuckets": [
    ],
  • "advancedResourceBuckets": [
    ],
  • "maxRetriesPerInstance": 1,
  • "shortname": "blend-task-1",
  • "profile": "blender",
  • "jobUuid": "12345678-1234-1234-1234-123456789012",
  • "resultBucket": "mybucket",
  • "constants": [
    ],
  • "forcedConstants": [
    ],
  • "hardwareConstraints": [
    ],
  • "secretsAccessRights": {
    },
  • "tags": [
    ],
  • "snapshotInterval": 0,
  • "snapshotWhitelist": ".*wanted.*",
  • "snapshotBlacklist": ".*forbid.*",
  • "snapshotBucket": "snapshots",
  • "snapshotBucketPrefix": "prefix",
  • "resultsWhitelist": ".*wanted.*",
  • "resultsBlacklist": ".*forbid.*",
  • "resultsBucket": "results",
  • "resultsBucketPrefix": "prefix",
  • "dependencies": {
    },
  • "autoDeleteOnCompletion": false,
  • "completionTimeToLive": "10:00:00",
  • "waitForPoolResourcesSynchronization": 16,
  • "uploadResultsOnCancellation": false,
  • "labels": {
    },
  • "schedulingType": "flex",
  • "targetedReservedMachineKey": "string",
  • "defaultResourcesCacheTTLSec": 0,
  • "resultsCacheTTLSec": 0,
  • "privileges": {
    },
  • "retrySettings": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Resume task (Auth)

Resuming a task's cancelled instances with the possibility to change the value of some fields.

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string
Request Body schema:

New task configuration. Will update these fields in the new created task.

name
string or null

Given Name of the cloned task. Same as the original by default.

Should be less than 2048 characters.

resourceBuckets
Array of strings or null

Names of the buckets containing resources for the task.

The buckets should already exist in the user storage account.

If AdvancedResourceBuckets is set its value will be used instead.

Maximum number of buckets: 100.

Array of objects or null (ResourcesBucket)

Names of the buckets containing resources for the task, with custom prefix.

The buckets should already exist in the user storage account.

Will override the value of ResourceBuckets.

Maximum number of buckets: 100.

maxRetriesPerInstance
integer or null <int32>
Deprecated

Maximum number of retries per instance.

If RetrySettings.MaxPerInstanceRetries is set, it will be used instead.

Prefer the use of RetrySettings.MaxPerInstanceRetries field

shortname
string or null

Shortname of the task (default is its Uuid).

Should be unique.

Available characters (all alphanumeric + hyphen): a-z, A-Z, 0-9 and -. Should start with a letter or number and should not end with an hyphen (-).

profile
string or null

Profile used by the task

Should be one of the available profiles for the user.

Should not be set if the task is using a pool

jobUuid
string or null <uuid>

Uuid of the task's job.

Should be the uuid of an active job.

resultBucket
string or null

Name of the bucket containing results of the task.

If the bucket does not exist in the user storage account, it will be created.

Array of objects or null (KeyValue)

List of constants for the task.

They are used to configure the profiles and can be overridden to change its parameters. New constants can also be added to use during the Task execution.

Allowed characters for the constants' keys: a-z, A-Z, 0-9, _, -, . The constants' keys and values should not be null.

Maximum number of constants is 150. Maximum length of the key and value: 2048 characters.

For secret constants with write-only rights, use the prefix 'QARNOT_SECRET__'

Array of objects or null (ForcedConstant)

List of constants to be overriden for the task.

This is expected to be used in a development context and requires specific permissions.

The same restrictions that apply to regular constants also apply here.

Array of HardwareConstraint (object) or MinimumCoreHardware (object) or MaximumCoreHardware (object) or MinimumRamHardware (object) or MaximumRamHardware (object) or SpecificHardware (object) or MinimumRamCoreRatioHardware (object) or MaximumRamCoreRatioHardware (object) or SSDHardware (object) or NoSSDHardware (object) or NoGpuHardware (object) or GpuHardware (object) or CpuModelHardware (object) or null

Constraints applied to hardware for executing the task.

Cannot set new hardware constraints for a task in a pool.

object (SecretsAccessRights)

Describe secrets the task or pool will have access to when running.

tags
Array of strings or null

(Optional) List of tags

Should be less than 10.

The tags values should not be null and should be less than 512 characters.

snapshotInterval
integer or null <int32>
Deprecated

Snapshot interval.

Cannot be set at task creation (reset to 0). Use periodic snapshot endpoint to set the snapshot interval

snapshotWhitelist
string or null

(Optional) Regex of whitelisted files for snapshots

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

snapshotBlacklist
string or null

(Optional) Regex of blacklisted files for snapshots

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

snapshotBucket
string or null

Name of the snapshot bucket

snapshotBucketPrefix
string or null

Prefix for the snapshot bucket

resultsWhitelist
string or null

(Optional) Regex of whitelisted files for results

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

resultsBlacklist
string or null

(Optional) Regex of blacklisted files for results

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

resultsBucket
string or null

Name of the buckets used for results

resultsBucketPrefix
string or null

Prefix to add to bucket for results

object (DependencyInput)

Initial task dependency

autoDeleteOnCompletion
boolean or null

Whether the task should be deleted if completed and the task quota is reached

completionTimeToLive
string or null <date-span>

Task life time limit

waitForPoolResourcesSynchronization
boolean or null

For in-pool tasks, whether to consider pool resources synchronization as a barrier for execution

uploadResultsOnCancellation
boolean or null

Whether the results should be upload if the task is cancelled

object or null

Task labels : arbitrary key / value pairs attached to the task in order to find it more easily.

They do not affect the execution of the task.

schedulingType
string (SchedulingClass)
Enum: "flex" "onDemand" "reserved"

Type of scheduling used when dispatching the tasks

targetedReservedMachineKey
string or null

The key of the reserved machine the task should be dispatch on. To use with "reserved" SchedulingType

defaultResourcesCacheTTLSec
integer or null <int32>

The default TTL value for all the task resources cache. TTL is 7776000s by default.

resultsCacheTTLSec
integer or null <int32>

The TTL value for the task results cache.

object (Privileges)

List of privileges that can be granted for task execution

object (RetrySettings)

Configuration for instance or task retry

Responses

Request samples

Content type
{
  • "name": "my blend",
  • "resourceBuckets": [
    ],
  • "advancedResourceBuckets": [
    ],
  • "maxRetriesPerInstance": 1,
  • "shortname": "blend-task-1",
  • "profile": "blender",
  • "jobUuid": "12345678-1234-1234-1234-123456789012",
  • "resultBucket": "mybucket",
  • "constants": [
    ],
  • "forcedConstants": [
    ],
  • "hardwareConstraints": [
    ],
  • "secretsAccessRights": {
    },
  • "tags": [
    ],
  • "snapshotInterval": 0,
  • "snapshotWhitelist": ".*wanted.*",
  • "snapshotBlacklist": ".*forbid.*",
  • "snapshotBucket": "snapshots",
  • "snapshotBucketPrefix": "prefix",
  • "resultsWhitelist": ".*wanted.*",
  • "resultsBlacklist": ".*forbid.*",
  • "resultsBucket": "results",
  • "resultsBucketPrefix": "prefix",
  • "dependencies": {
    },
  • "autoDeleteOnCompletion": false,
  • "completionTimeToLive": "10:00:00",
  • "waitForPoolResourcesSynchronization": 16,
  • "uploadResultsOnCancellation": false,
  • "labels": {
    },
  • "schedulingType": "flex",
  • "targetedReservedMachineKey": "string",
  • "defaultResourcesCacheTTLSec": 0,
  • "resultsCacheTTLSec": 0,
  • "privileges": {
    },
  • "retrySettings": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Clone Task (Auth)

Cloning a task with the possibility to change the value of some fields.

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string
Request Body schema:

New task configuration. Will update these fields in the new created task.

name
string or null

Given Name of the cloned task. Same as the original by default.

Should be less than 2048 characters.

instanceCount
integer or null <int32>

Number of task instances.

For a more complex definition of instance ids, use AdvancedRanges instead.

If AdvancedRanges is set its value will be used instead.

advancedRanges
string or null

Range of task instances, represented by a comma-separated list of specific id values or continuous ranges defined by hyphens (-).

Will override the value of InstanceCount.

resourceBuckets
Array of strings or null

Names of the buckets containing resources for the task.

The buckets should already exist in the user storage account.

If AdvancedResourceBuckets is set its value will be used instead.

Maximum number of buckets: 100.

Array of objects or null (ResourcesBucket)

Names of the buckets containing resources for the task, with custom prefix.

The buckets should already exist in the user storage account.

Will override the value of ResourceBuckets.

Maximum number of buckets: 100.

maxRetriesPerInstance
integer or null <int32>
Deprecated

Maximum number of retries per instance.

If RetrySettings.MaxPerInstanceRetries is set, it will be used instead.

Prefer the use of RetrySettings.MaxPerInstanceRetries field

shortname
string or null

Shortname of the task (default is its Uuid).

Should be unique.

Available characters (all alphanumeric + hyphen): a-z, A-Z, 0-9 and -. Should start with a letter or number and should not end with an hyphen (-).

profile
string or null

Profile used by the task

Should be one of the available profiles for the user.

Should not be set if the task is using a pool

jobUuid
string or null <uuid>

Uuid of the task's job.

Should be the uuid of an active job.

resultBucket
string or null

Name of the bucket containing results of the task.

If the bucket does not exist in the user storage account, it will be created.

Array of objects or null (KeyValue)

List of constants for the task.

They are used to configure the profiles and can be overridden to change its parameters. New constants can also be added to use during the Task execution.

Allowed characters for the constants' keys: a-z, A-Z, 0-9, _, -, . The constants' keys and values should not be null.

Maximum number of constants is 150. Maximum length of the key and value: 2048 characters.

For secret constants with write-only rights, use the prefix 'QARNOT_SECRET__'

Array of objects or null (ForcedConstant)

List of constants to be overriden for the task.

This is expected to be used in a development context and requires specific permissions.

The same restrictions that apply to regular constants also apply here.

Array of HardwareConstraint (object) or MinimumCoreHardware (object) or MaximumCoreHardware (object) or MinimumRamHardware (object) or MaximumRamHardware (object) or SpecificHardware (object) or MinimumRamCoreRatioHardware (object) or MaximumRamCoreRatioHardware (object) or SSDHardware (object) or NoSSDHardware (object) or NoGpuHardware (object) or GpuHardware (object) or CpuModelHardware (object) or null

Constraints applied to hardware for executing the task.

Cannot set new hardware constraints for a task in a pool.

object (SecretsAccessRights)

Describe secrets the task or pool will have access to when running.

tags
Array of strings or null

(Optional) List of tags

Should be less than 10.

The tags values should not be null and should be less than 512 characters.

snapshotInterval
integer or null <int32>
Deprecated

Snapshot interval.

Cannot be set at task creation (reset to 0). Use periodic snapshot endpoint to set the snapshot interval

snapshotWhitelist
string or null

(Optional) Regex of whitelisted files for snapshots

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

snapshotBlacklist
string or null

(Optional) Regex of blacklisted files for snapshots

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

snapshotBucket
string or null

Name of the snapshot bucket

snapshotBucketPrefix
string or null

Prefix for the snapshot bucket

resultsWhitelist
string or null

(Optional) Regex of whitelisted files for results

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

resultsBlacklist
string or null

(Optional) Regex of blacklisted files for results

Should be less than 2048 characters.

You can use the values of task constants in the regex using ${CONSTANT_KEY}

resultsBucket
string or null

Name of the buckets used for results

resultsBucketPrefix
string or null

Prefix to add to bucket for results

object (DependencyInput)

Initial task dependency

autoDeleteOnCompletion
boolean or null

Whether the task should be deleted if completed and the task quota is reached

completionTimeToLive
string or null <date-span>

Task life time limit

waitForPoolResourcesSynchronization
boolean or null

For in-pool tasks, whether to consider pool resources synchronization as a barrier for execution

uploadResultsOnCancellation
boolean or null

Whether the results should be upload if the task is cancelled

object or null

Task labels : arbitrary key / value pairs attached to the task in order to find it more easily.

They do not affect the execution of the task.

schedulingType
string (SchedulingClass)
Enum: "flex" "onDemand" "reserved"

Type of scheduling used when dispatching the tasks

targetedReservedMachineKey
string or null

The key of the reserved machine the task should be dispatch on. To use with "reserved" SchedulingType

defaultResourcesCacheTTLSec
integer or null <int32>

The default TTL value for all the task resources cache. TTL is 7776000s by default.

resultsCacheTTLSec
integer or null <int32>

The TTL value for the task results cache.

object (Privileges)

List of privileges that can be granted for task execution

object (RetrySettings)

Configuration for instance or task retry

Responses

Request samples

Content type
{
  • "name": "my blend",
  • "instanceCount": 4,
  • "advancedRanges": "0-2,4-5,17",
  • "resourceBuckets": [
    ],
  • "advancedResourceBuckets": [
    ],
  • "maxRetriesPerInstance": 1,
  • "shortname": "blend-task-1",
  • "profile": "blender",
  • "jobUuid": "12345678-1234-1234-1234-123456789012",
  • "resultBucket": "mybucket",
  • "constants": [
    ],
  • "forcedConstants": [
    ],
  • "hardwareConstraints": [
    ],
  • "secretsAccessRights": {
    },
  • "tags": [
    ],
  • "snapshotInterval": 0,
  • "snapshotWhitelist": ".*wanted.*",
  • "snapshotBlacklist": ".*forbid.*",
  • "snapshotBucket": "snapshots",
  • "snapshotBucketPrefix": "prefix",
  • "resultsWhitelist": ".*wanted.*",
  • "resultsBlacklist": ".*forbid.*",
  • "resultsBucket": "results",
  • "resultsBucketPrefix": "prefix",
  • "dependencies": {
    },
  • "autoDeleteOnCompletion": false,
  • "completionTimeToLive": "10:00:00",
  • "waitForPoolResourcesSynchronization": 16,
  • "uploadResultsOnCancellation": false,
  • "labels": {
    },
  • "schedulingType": "flex",
  • "targetedReservedMachineKey": "string",
  • "defaultResourcesCacheTTLSec": 0,
  • "resultsCacheTTLSec": 0,
  • "privileges": {
    },
  • "retrySettings": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Update task (Auth)

Updating a running task

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string
Request Body schema:

New task configuration. Will update these fields of the running task.

Array of objects or null (KeyValue)

List of new constants for the pool

tags
Array of strings or null

List of new tags for the pool

Responses

Request samples

Content type
{
  • "constants": [
    ],
  • "tags": [
    ]
}

Update Task's resources (Auth)

Trigger resources update of running task on compute nodes. Compute nodes will see new files uploaded to the bucket since the last resources synchronization (either at node provisioning, or from an earlier call to this method) and get an updated version of files that were modified in the bucket. NOTE: Files that were deleted from the bucket since the last synchronization WILL NOT be deleted from compute nodes.

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string

Responses

Request samples 

curl -X PATCH -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/{taskUuid}

Delete Task (Auth)

Delete a task (abort if needed)

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string

Responses

Request samples 

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/{taskUuid}

Task Information (Auth)

Get information of the specified task

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/{taskUuid}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "resourceBuckets": [
    ],
  • "advancedResourceBuckets": [
    ],
  • "resultBucket": "mybucket",
  • "resultsCacheTTLSec": 0,
  • "completedInstances": [
    ],
  • "status": {
    },
  • "snapshotInterval": 0,
  • "resultsCount": 0,
  • "constants": [
    ],
  • "secretsAccessRights": {
    },
  • "tags": [
    ],
  • "snapshotWhitelist": ".*wanted.*",
  • "snapshotBlacklist": ".*forbid.*",
  • "snapshotBucket": "snapshots",
  • "snapshotBucketPrefix": "prefix",
  • "resultsWhitelist": ".*wanted.*",
  • "resultsBlacklist": ".*forbid.*",
  • "resultsBucket": "results",
  • "resultsBucketPrefix": "prefix",
  • "uploadResultsOnCancellation": false,
  • "dependencies": {
    },
  • "autoDeleteOnCompletion": false,
  • "completionTimeToLive": "10:00:00",
  • "hardwareConstraints": [
    ],
  • "labels": {
    },
  • "schedulingType": "flex",
  • "targetedReservedMachineKey": "string",
  • "privileges": {
    },
  • "retrySettings": {
    },
  • "uuid": "52c10b2d-0687-41e1-985e-7279f6dd543a",
  • "name": "my blend",
  • "shortname": "blend-task-1",
  • "profile": "blender",
  • "poolUuid": "62e80aae-d20a-4608-b873-ec8bff991733",
  • "jobUuid": "12345678-1234-1234-1234-123456789012",
  • "progress": 0.3,
  • "runningInstanceCount": 2,
  • "runningCoreCount": 16,
  • "clusterInfo": {
    },
  • "executionTime": "00:00:00",
  • "wallTime": "00:00:00",
  • "state": "FullyExecuting",
  • "previousState": "PartiallyExecuting",
  • "totalInstanceCount": 4,
  • "instanceCount": 4,
  • "maxRetriesPerInstance": 1,
  • "advancedRanges": "0-2,4-5,17",
  • "stateTransitionTime": "2021-05-01T19:00:00Z",
  • "previousStateTransitionTime": "2021-05-01T17:56:29Z",
  • "lastModified": "2021-05-01T19:01:29Z",
  • "creationDate": "2021-05-01T15:04:27Z",
  • "endDate": "2021-05-01T21:13:14Z",
  • "waitForPoolResourcesSynchronization": 16
}

Abort Task (Auth)

Abort a task.

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string

Responses

Request samples 

curl -X POST -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/{taskUuid}/abort

Task Std Out (Auth)

Get task standard output (can be rotated).

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/{taskUuid}/stdout

Last Task Std Out (Auth)

Get task standard output (can be rotated) since last access.

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string

Responses

Request samples 

curl -X POST -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/{taskUuid}/stdout

Task Instance Std Out (Auth)

Get standard output of a specific task instance (can be rotated).

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

instanceId
required
integer <int32>

Id of the instance

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/{taskUuid}/stdout/{instanceId}

Last Task Instance Std Out (Auth)

Get standard output of a specific task instance (can be rotated) since last access.

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

instanceId
required
integer <int32>

Id of the instance

version
required
string

Responses

Request samples 

curl -X POST -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/{taskUuid}/stdout/{instanceId}

Task Std Err (Auth)

Get Error output of the task (can be rotated).

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/{taskUuid}/stderr

Last Task Std Err (Auth)

Get Error output of the task (can be rotated) since last access.

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string

Responses

Request samples 

curl -X POST -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/{taskUuid}/stderr

Task Instance Std Err (Auth)

Get Error output of a specific task instance (can be rotated).

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

instanceId
required
integer <int32>

Id of the instance

version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/{taskUuid}/stderr/{instanceId}

Last Task Instance Std Err (Auth)

Get Error output of a specific task instance (can be rotated) since last access.

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

instanceId
required
integer <int32>

Id of the instance

version
required
string

Responses

Request samples 

curl -X POST -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/{taskUuid}/stderr/{instanceId}

Restart Task (Auth) Deprecated

Restart a task.

Deprecated. Use 'clone' or 'recover' instead

Authorizations:
Authorization
path Parameters
taskUuid
required
string
Example: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

Uuid of the task

version
required
string

Responses

Request samples 

curl -X POST -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/tasks/{taskUuid}/restart

Get task Carbon Facts.

Authorizations:
Authorization
path Parameters
taskId
required
string <uuid>

Uuid of the task.

query Parameters
comparisonDatacenter
string

Name of the datacenter used for the comparison.

Responses

Response samples

Content type
No sample

Users

User info (Auth)

Get the information about the authenticated user

Authorizations:
Authorization
path Parameters
version
required
string
header Parameters
QarnotReadOnlyRequestForAccount
string

Read only access to another account

Responses

Request samples 

curl -X GET -H "Content-Type: application/json" -H "Authorization: token"  https://localhost/v{version}/info

Response samples

Content type
application/json
{
  • "email": "some@user.com",
  • "maxBucket": 100,
  • "maxTask": 100,
  • "taskCount": 2,
  • "maxJob": 100,
  • "jobCount": 1,
  • "maxPool": 50,
  • "poolCount": 1,
  • "maxRunningTask": 10,
  • "maxRunningPool": 50,
  • "runningTaskCount": 1,
  • "runningPoolCount": 1,
  • "runningInstanceCount": 2,
  • "runningCoreCount": 16,
  • "maxInstances": 64,
  • "maxCores": 512,
  • "maxFlexInstances": 64,
  • "maxFlexCores": 512,
  • "maxOnDemandInstances": 64,
  • "maxOnDemandCores": 512,
  • "computingQuotas": {
    },
  • "quotaBytes": 10737418240,
  • "quotaBytesBucket": 2147483648,
  • "usedQuotaBytesBucket": 0,
  • "usedQuotaBytes": 0,
  • "defaultScheduling": "string",
  • "defaultReservedSpecificationKey": "string"
}

Versions

API Versions

Get the list of available versions of the API with their planned end of life

Authorizations:
Authorization
path Parameters
version
required
string

Responses

Request samples 

curl -X GET -H "Content-Type: application/json"   https://localhost/v{version}/versions

Response samples

Content type
application/json
[
  • {
    }
]