Task Sources

Lists all task sources.

get

API Key Scope: task_sources / index

Authorizations

AuthorizationstringRequired

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

Path parameters

task_idstringRequired

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

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

Responses

200

List of task sources.

application/json

countintegerRead-onlyOptionalExample: 1

get/tasks/{task_id}/task_sources

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

200

List of task sources.

{
  "count": 1,
  "task_sources": [
    {
      "id": "text",
      "type": "primary_nas",
      "node_paths": [
        "text"
      ],
      "range": [
        150000,
        290000
      ],
      "pool_id": 1,
      "parent_storage_id": 1,
      "storage_id": 1,
      "storage_name": "text",
      "pool": {
        "id": 6,
        "name": "offline-pools",
        "comment": "",
        "type": "offline_archive",
        "content": "cloud",
        "storage_id": 2
      }
    }
  ]
}

Creates a new task source.

post

API Key Scope: task_sources / create

Authorizations

AuthorizationstringRequired

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

Path parameters

task_idstringRequired

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

Body

idstring · int64Read-onlyOptional

typestring · enumOptionalPossible values:

node_pathsstring[]Optional

rangeinteger[] · min: 2 · max: 2OptionalExample: [150000,290000]

pool_idintegerOptional

parent_storage_idinteger · int64Optional

storage_idinteger · int64Optional

storage_namestringOptional

Responses

201

A specific task source.

application/json

idstring · int64Read-onlyOptional

typestring · enumOptionalPossible values:

node_pathsstring[]Optional

rangeinteger[] · min: 2 · max: 2OptionalExample: [150000,290000]

pool_idintegerOptional

parent_storage_idinteger · int64Optional

storage_idinteger · int64Optional

storage_namestringOptional

422

The received resource was not correctly formatted.

application/json

post/tasks/{task_id}/task_sources

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

{
  "type": "primary_nas",
  "node_paths": [
    "text"
  ],
  "range": [
    150000,
    290000
  ],
  "pool_id": 1,
  "parent_storage_id": 1,
  "storage_id": 1,
  "storage_name": "text"
}

{
  "id": "text",
  "type": "primary_nas",
  "node_paths": [
    "text"
  ],
  "range": [
    150000,
    290000
  ],
  "pool_id": 1,
  "parent_storage_id": 1,
  "storage_id": 1,
  "storage_name": "text",
  "pool": {
    "id": 6,
    "name": "offline-pools",
    "comment": "",
    "type": "offline_archive",
    "content": "cloud",
    "storage_id": 2
  }
}

Displays a specific task source.

get

API Key Scope: task_sources / show

Authorizations

AuthorizationstringRequired

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

Path parameters

task_idstringRequired

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

task_source_idstringRequired

ID of task source.

Responses

200

A specific task source.

application/json

idstring · int64Read-onlyOptional

typestring · enumOptionalPossible values:

node_pathsstring[]Optional

rangeinteger[] · min: 2 · max: 2OptionalExample: [150000,290000]

pool_idintegerOptional

parent_storage_idinteger · int64Optional

storage_idinteger · int64Optional

storage_namestringOptional

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get/tasks/{task_id}/task_sources/{task_source_id}

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

{
  "id": "text",
  "type": "primary_nas",
  "node_paths": [
    "text"
  ],
  "range": [
    150000,
    290000
  ],
  "pool_id": 1,
  "parent_storage_id": 1,
  "storage_id": 1,
  "storage_name": "text",
  "pool": {
    "id": 6,
    "name": "offline-pools",
    "comment": "",
    "type": "offline_archive",
    "content": "cloud",
    "storage_id": 2
  }
}

Updates a specific task source.

put

API Key Scope: task_sources / update

Authorizations

AuthorizationstringRequired

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

Path parameters

task_idstringRequired

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

task_source_idstringRequired

ID of task source.

Body

idstring · int64Read-onlyOptional

typestring · enumOptionalPossible values:

node_pathsstring[]Optional

rangeinteger[] · min: 2 · max: 2OptionalExample: [150000,290000]

pool_idintegerOptional

parent_storage_idinteger · int64Optional

storage_idinteger · int64Optional

storage_namestringOptional

Responses

200

A specific task source.

application/json

idstring · int64Read-onlyOptional

typestring · enumOptionalPossible values:

node_pathsstring[]Optional

rangeinteger[] · min: 2 · max: 2OptionalExample: [150000,290000]

pool_idintegerOptional

parent_storage_idinteger · int64Optional

storage_idinteger · int64Optional

storage_namestringOptional

422

The received resource was not correctly formatted.

application/json

put/tasks/{task_id}/task_sources/{task_source_id}

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

{
  "type": "primary_nas",
  "node_paths": [
    "text"
  ],
  "range": [
    150000,
    290000
  ],
  "pool_id": 1,
  "parent_storage_id": 1,
  "storage_id": 1,
  "storage_name": "text"
}

{
  "id": "text",
  "type": "primary_nas",
  "node_paths": [
    "text"
  ],
  "range": [
    150000,
    290000
  ],
  "pool_id": 1,
  "parent_storage_id": 1,
  "storage_id": 1,
  "storage_name": "text",
  "pool": {
    "id": 6,
    "name": "offline-pools",
    "comment": "",
    "type": "offline_archive",
    "content": "cloud",
    "storage_id": 2
  }
}

Destroys a specific task source.

delete

API Key Scope: task_sources / destroy

Authorizations

AuthorizationstringRequired

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

Path parameters

task_idstringRequired

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

task_source_idstringRequired

ID of task source.

Responses

204

Task source destroyed.

No content

delete/tasks/{task_id}/task_sources/{task_source_id}

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

204

Task source destroyed.

No content