Task_destinations

Lists all task destinations.

get

API Key Scope: task_destinations / 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

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 destinations.

application/json

get

/tasks/{task_id}/task_destinations

HTTPcURLJavaScriptPython

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

200

List of task destinations.

{
  "count": 1,
  "task_destinations": []
}

Creates a new task destination.

post

API Key Scope: task_destinations / 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

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

Body

application/json

idstringRead-onlyOptional

typestring · enumOptionalPossible values:

node_pathstringOptional

pool_idintegerOptional

parent_storage_idinteger · int64Optional

storage_idinteger · int64Optional

storage_namestringOptional

Responses

201

A specific task destination.

application/json

422

The received resource was not correctly formatted.

application/json

post

/tasks/{task_id}/task_destinations

HTTPcURLJavaScriptPython

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

{
  "type": "container",
  "node_path": "text",
  "pool_id": 1,
  "parent_storage_id": 1,
  "storage_id": 1,
  "storage_name": "text"
}

{
  "id": "text",
  "type": "container",
  "node_path": "text",
  "pool_id": 1,
  "parent_storage_id": 1,
  "storage_id": 1,
  "storage_name": "text",
  "pool": {
    "id": 6,
    "name": "offline-tapes",
    "comment": "",
    "type": "offline_archive",
    "content": "tape",
    "storage_id": 2,
    "tape_write_protect_when_full": true
  },
  "container": {
    "id": 100,
    "name": "my-container",
    "comment": "Read only container for random stuff",
    "push_pool_id": 1,
    "cleaning_pool_id": 1,
    "quota_total_size": 1,
    "quota_on_cache": 1,
    "stat_total_files": 99301,
    "only_on_cache_file_count": 19123,
    "stat_total_size": 6145076462,
    "stat_size_on_cache": 6899417088,
    "only_on_cache_file_size_sum": 3294517012,
    "guest_right": "read",
    "last_update": "2019-08-05T14:24:15.000Z"
  }
}

Displays a specific task destination.

get

API Key Scope: task_destinations / 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

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

task_destination_idstringRequired

ID of task destination.

Responses

200

A specific task destination.

application/json

404

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

application/json

get

/tasks/{task_id}/task_destinations/{task_destination_id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "type": "container",
  "node_path": "text",
  "pool_id": 1,
  "parent_storage_id": 1,
  "storage_id": 1,
  "storage_name": "text",
  "pool": {
    "id": 6,
    "name": "offline-tapes",
    "comment": "",
    "type": "offline_archive",
    "content": "tape",
    "storage_id": 2,
    "tape_write_protect_when_full": true
  },
  "container": {
    "id": 100,
    "name": "my-container",
    "comment": "Read only container for random stuff",
    "push_pool_id": 1,
    "cleaning_pool_id": 1,
    "quota_total_size": 1,
    "quota_on_cache": 1,
    "stat_total_files": 99301,
    "only_on_cache_file_count": 19123,
    "stat_total_size": 6145076462,
    "stat_size_on_cache": 6899417088,
    "only_on_cache_file_size_sum": 3294517012,
    "guest_right": "read",
    "last_update": "2019-08-05T14:24:15.000Z"
  }
}

Updates a specific task destination.

put

API Key Scope: task_destinations / 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

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

task_destination_idstringRequired

ID of task destination.

Body

application/json

idstringRead-onlyOptional

typestring · enumOptionalPossible values:

node_pathstringOptional

pool_idintegerOptional

parent_storage_idinteger · int64Optional

storage_idinteger · int64Optional

storage_namestringOptional

Responses

200

A specific task destination.

application/json

422

The received resource was not correctly formatted.

application/json

put

/tasks/{task_id}/task_destinations/{task_destination_id}

HTTPcURLJavaScriptPython

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

{
  "type": "container",
  "node_path": "text",
  "pool_id": 1,
  "parent_storage_id": 1,
  "storage_id": 1,
  "storage_name": "text"
}

{
  "id": "text",
  "type": "container",
  "node_path": "text",
  "pool_id": 1,
  "parent_storage_id": 1,
  "storage_id": 1,
  "storage_name": "text",
  "pool": {
    "id": 6,
    "name": "offline-tapes",
    "comment": "",
    "type": "offline_archive",
    "content": "tape",
    "storage_id": 2,
    "tape_write_protect_when_full": true
  },
  "container": {
    "id": 100,
    "name": "my-container",
    "comment": "Read only container for random stuff",
    "push_pool_id": 1,
    "cleaning_pool_id": 1,
    "quota_total_size": 1,
    "quota_on_cache": 1,
    "stat_total_files": 99301,
    "only_on_cache_file_count": 19123,
    "stat_total_size": 6145076462,
    "stat_size_on_cache": 6899417088,
    "only_on_cache_file_size_sum": 3294517012,
    "guest_right": "read",
    "last_update": "2019-08-05T14:24:15.000Z"
  }
}

Destroys a specific task destination.

delete

API Key Scope: task_destinations / 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

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

task_destination_idstringRequired

ID of task destination.

Responses

204

Task destination destroyed.

delete

/tasks/{task_id}/task_destinations/{task_destination_id}

HTTPcURLJavaScriptPython

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

204

Task destination destroyed.

No content