Task_options

Lists all task options.

get

API Key Scope: task_options / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

idstringOptional

Filter on id

typestringOptional

Filter on type

valuestringOptional

Filter on value

Responses

200

List of task options.

application/json

get

/tasks/{task_id}/task_options

HTTPcURLJavaScriptPython

GET /api/v2/tasks/{task_id}/task_options HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of task options.

{
  "count": 1,
  "task_options": [
    {
      "id": 1,
      "type": "file_checksum",
      "value": "text"
    }
  ]
}

Creates a new task option.

post

API Key Scope: task_options / create

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

Body

application/json

idinteger · int64Read-onlyOptional

typestring · enumOptionalPossible values:

valuestringOptional

Responses

201

A specific task option.

application/json

422

The received resource was not correctly formatted.

application/json

post

/tasks/{task_id}/task_options

HTTPcURLJavaScriptPython

POST /api/v2/tasks/{task_id}/task_options HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "type": "file_checksum",
  "value": "text"
}

{
  "id": 1,
  "type": "file_checksum",
  "value": "text"
}

Displays a specific task option.

get

API Key Scope: task_options / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

task_option_idintegerRequired

Numeric ID of task option.

Responses

200

A specific task option.

application/json

get

/tasks/{task_id}/task_options/{task_option_id}

HTTPcURLJavaScriptPython

GET /api/v2/tasks/{task_id}/task_options/{task_option_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

A specific task option.

{
  "id": 1,
  "type": "file_checksum",
  "value": "text"
}

Updates a specific task option.

put

API Key Scope: task_options / update

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

task_option_idintegerRequired

Numeric ID of task option.

Body

application/json

idinteger · int64Read-onlyOptional

typestring · enumOptionalPossible values:

valuestringOptional

Responses

200

A specific task option.

application/json

422

The received resource was not correctly formatted.

application/json

put

/tasks/{task_id}/task_options/{task_option_id}

HTTPcURLJavaScriptPython

PUT /api/v2/tasks/{task_id}/task_options/{task_option_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "type": "file_checksum",
  "value": "text"
}

{
  "id": 1,
  "type": "file_checksum",
  "value": "text"
}

Destroys a specific task option.

delete

API Key Scope: task_options / destroy

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

task_option_idintegerRequired

Numeric ID of task option.

Responses

204

Task option destroyed.

delete

/tasks/{task_id}/task_options/{task_option_id}

HTTPcURLJavaScriptPython

DELETE /api/v2/tasks/{task_id}/task_options/{task_option_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

204

Task option destroyed.

No content