7.8. API

GET /actions/
Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].action (string) – (required)

  • results[].id (integer) – (read only)

  • results[].state (string) –

POST /actions/
Request JSON Object

  • action (string) – (required)

Status Codes
Response JSON Object

  • action (string) – (required)

GET /actions/{id}/
Parameters

  • id (string) –

Status Codes
Response JSON Object

  • action (string) – (required)

  • id (integer) – (read only)

  • results (string) – (read only)

  • state (string) –

  • user (integer) –

GET /auth/clientkeys/

API endpoint for managing client keys

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].id (integer) – (read only)

  • results[].name (string) – Name of the client key (required)

  • results[].url (string) – (read only)

POST /auth/clientkeys/

API endpoint for managing client keys

Request JSON Object

  • api_key (string) – (read only)

  • id (integer) – (read only)

  • name (string) – Name of the client key (required)

  • url (string) – (read only)

Status Codes
Response JSON Object

  • api_key (string) – (read only)

  • id (integer) – (read only)

  • name (string) – Name of the client key (required)

  • url (string) – (read only)

GET /auth/clientkeys/{id}/

API endpoint for managing client keys

Parameters

  • id (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) – Name of the client key (required)

  • url (string) – (read only)

PATCH /auth/clientkeys/{id}/

API endpoint for managing client keys

Parameters

  • id (string) –

Request JSON Object

  • id (integer) – (read only)

  • name (string) – Name of the client key (required)

  • url (string) – (read only)

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) – Name of the client key (required)

  • url (string) – (read only)

DELETE /auth/clientkeys/{id}/

API endpoint for managing client keys

Parameters

  • id (string) –

Status Codes
POST /auth/token/
Request JSON Object

  • password (string) – (required)

  • username (string) – (required)

Status Codes
Response JSON Object

  • password (string) – (required)

  • username (string) – (required)

GET /auth/token/publickey/

API endpoint for retrieving public key that is used for token verification.

Status Codes
POST /auth/token/refresh/

Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

Request JSON Object

  • access (string) – (read only)

  • refresh (string) – (required)

Status Codes
Response JSON Object

  • access (string) – (read only)

  • refresh (string) – (required)

POST /auth/token/verify/

Verifies that the token is not expired AND the token owner exists in the database AND the token owner is an active user.

Request JSON Object

  • token (string) – (required)

  • type (string) – Token type e.g: access or refresh (required)

Status Codes
Response JSON Object

  • token (string) – (required)

  • type (string) – Token type e.g: access or refresh (required)

GET /configurations/

API endpoint for viewing and setting configurations.

Status Codes
Response JSON Object

  • custom_statistics_tasks (object) – A list of custom tasks to be considered discovery tasks

  • jobs_ttl (integer) – Time to store job details after the job completes, in days

  • search_backend (string) – Search backend

  • search_max_results (integer) – Maximum search results

  • search_result_ttl (integer) – Maximum time to store search results in days

  • snapdiff_stream_timeout (integer) – Maximum amount of minutes to wait for task results

  • snapshot_create_delete_retry_timeout (integer) – Maximum time for workers to retry snapshot create and delete operations, in seconds

  • stat_refresh_period (integer) – Maximum time to wait for results from stat in seconds

  • stat_timeout (integer) – Maximum time to wait for results from stat in seconds

  • task_invalidation_timeout (integer) – Maximum amount of minutes before a task in the STARTED state is considered invalid

PATCH /configurations/

API endpoint for viewing and setting configurations.

Request JSON Object

  • custom_statistics_tasks (object) – A list of custom tasks to be considered discovery tasks

  • jobs_ttl (integer) – Time to store job details after the job completes, in days

  • search_backend (string) – Search backend

  • search_max_results (integer) – Maximum search results

  • search_result_ttl (integer) – Maximum time to store search results in days

  • snapdiff_stream_timeout (integer) – Maximum amount of minutes to wait for task results

  • snapshot_create_delete_retry_timeout (integer) – Maximum time for workers to retry snapshot create and delete operations, in seconds

  • stat_refresh_period (integer) – Maximum time to wait for results from stat in seconds

  • stat_timeout (integer) – Maximum time to wait for results from stat in seconds

  • task_invalidation_timeout (integer) – Maximum amount of minutes before a task in the STARTED state is considered invalid

Status Codes
Response JSON Object

  • custom_statistics_tasks (object) – A list of custom tasks to be considered discovery tasks

  • jobs_ttl (integer) – Time to store job details after the job completes, in days

  • search_backend (string) – Search backend

  • search_max_results (integer) – Maximum search results

  • search_result_ttl (integer) – Maximum time to store search results in days

  • snapdiff_stream_timeout (integer) – Maximum amount of minutes to wait for task results

  • snapshot_create_delete_retry_timeout (integer) – Maximum time for workers to retry snapshot create and delete operations, in seconds

  • stat_refresh_period (integer) – Maximum time to wait for results from stat in seconds

  • stat_timeout (integer) – Maximum time to wait for results from stat in seconds

  • task_invalidation_timeout (integer) – Maximum amount of minutes before a task in the STARTED state is considered invalid

GET /datastores/

API endpoint for managing DataStores.

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].accesskey (string) –

  • results[].accesskeyid (string) –

  • results[].bucket (string) –

  • results[].container (string) –

  • results[].credentialsfile (string) –

  • results[].endpoint (string) –

  • results[].id (integer) – (read only)

  • results[].name (string) – DataStore Name (required)

  • results[].region (string) –

  • results[].secretaccesskey (string) –

  • results[].storageaccount (string) –

  • results[].type (string) – Site Type (required)

  • results[].url (string) – (read only)

POST /datastores/

API endpoint for managing DataStores.

Request JSON Object

  • accesskey (string) –

  • accesskeyid (string) –

  • bucket (string) –

  • container (string) –

  • credentialsfile (string) –

  • endpoint (string) –

  • id (integer) – (read only)

  • name (string) – DataStore Name (required)

  • region (string) –

  • secretaccesskey (string) –

  • storageaccount (string) –

  • type (string) – Site Type (required)

  • url (string) – (read only)

Status Codes
Response JSON Object

  • accesskey (string) –

  • accesskeyid (string) –

  • bucket (string) –

  • container (string) –

  • credentialsfile (string) –

  • endpoint (string) –

  • id (integer) – (read only)

  • name (string) – DataStore Name (required)

  • region (string) –

  • secretaccesskey (string) –

  • storageaccount (string) –

  • type (string) – Site Type (required)

  • url (string) – (read only)

GET /datastores/{id}/

API endpoint for managing DataStores.

Parameters

  • id (string) –

Status Codes
Response JSON Object

  • accesskey (string) –

  • accesskeyid (string) –

  • bucket (string) –

  • container (string) –

  • credentialsfile (string) –

  • endpoint (string) –

  • id (integer) – (read only)

  • name (string) – DataStore Name (required)

  • region (string) –

  • secretaccesskey (string) –

  • storageaccount (string) –

  • type (string) – Site Type (required)

  • url (string) – (read only)

PATCH /datastores/{id}/

API endpoint for managing DataStores.

Parameters

  • id (string) –

Request JSON Object

  • accesskey (string) –

  • accesskeyid (string) –

  • bucket (string) –

  • container (string) –

  • credentialsfile (string) –

  • endpoint (string) –

  • id (integer) – (read only)

  • name (string) – DataStore Name (required)

  • region (string) –

  • secretaccesskey (string) –

  • storageaccount (string) –

  • type (string) – Site Type (required)

  • url (string) – (read only)

Status Codes
Response JSON Object

  • accesskey (string) –

  • accesskeyid (string) –

  • bucket (string) –

  • container (string) –

  • credentialsfile (string) –

  • endpoint (string) –

  • id (integer) – (read only)

  • name (string) – DataStore Name (required)

  • region (string) –

  • secretaccesskey (string) –

  • storageaccount (string) –

  • type (string) – Site Type (required)

  • url (string) – (read only)

DELETE /datastores/{id}/

API endpoint for managing DataStores.

Parameters

  • id (string) –

Status Codes
GET /features/

API endpoint for managing feature flags.

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].description (string) – Description of what the feature does (read only)

  • results[].enabled (boolean) – Whether the feature has been enabled

  • results[].name (string) – Name of the feature (read only)

GET /features/{name}/

API endpoint for managing feature flags.

Parameters

  • name (string) –

Status Codes
Response JSON Object

  • description (string) – Description of what the feature does (read only)

  • enabled (boolean) – Whether the feature has been enabled

  • name (string) – Name of the feature (read only)

PATCH /features/{name}/

API endpoint for managing feature flags.

Parameters

  • name (string) –

Request JSON Object

  • description (string) – Description of what the feature does (read only)

  • enabled (boolean) – Whether the feature has been enabled

  • name (string) – Name of the feature (read only)

Status Codes
Response JSON Object

  • description (string) – Description of what the feature does (read only)

  • enabled (boolean) – Whether the feature has been enabled

  • name (string) – Name of the feature (read only)

GET /file/

Retrieves list of files under given path for given site.

Query Parameters

  • path (string) – Target directory path

  • site (string) – Site name

  • details (boolean) – Show details of children objects

  • cache_ttl (integer) – How long the cache will last for the target path

Status Codes
GET /file/test/

API endpoint for managing files.

Status Codes
POST /file/workflow/

Performs a workflow on a list of files

Request JSON Object

  • discovery (string) – Discovery name

  • exclude[] (string) –

  • fields (object) –

  • ignore_site_excludes (boolean) –

  • ignore_site_includes (boolean) –

  • include[] (string) –

  • job (integer) – Job ID

  • paths[] (object) –

  • site (string) – Site name (required)

  • workflow (string) – Workflow name (required)

Status Codes
Response JSON Object

  • discovery (string) – Discovery name

  • exclude[] (string) –

  • fields (object) –

  • ignore_site_excludes (boolean) –

  • ignore_site_includes (boolean) –

  • include[] (string) –

  • job (integer) – Job ID

  • paths[] (object) –

  • site (string) – Site name (required)

  • workflow (string) – Workflow name (required)

GET /filesets/

Retrieve list of filesets on a given site.

Query Parameters

  • site (string) – Site name

Status Codes
GET /filestatustypes/

API endpoint for managing file status types.

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].background_color (string) – (required)

  • results[].key (string) – (required)

  • results[].label (string) – (required)

  • results[].text_color (string) – (required)

  • results[].url (string) – (read only)

GET /filestatustypes/{key}/

API endpoint for managing file status types.

Parameters

  • key (string) –

Status Codes
Response JSON Object

  • background_color (string) – (required)

  • key (string) – (required)

  • label (string) – (required)

  • text_color (string) – (required)

  • url (string) – (read only)

PATCH /filestatustypes/{key}/

API endpoint for managing file status types.

Parameters

  • key (string) –

Request JSON Object

  • background_color (string) – (required)

  • label (string) – (required)

  • text_color (string) – (required)

Status Codes
Response JSON Object

  • background_color (string) – (required)

  • label (string) – (required)

  • text_color (string) – (required)

GET /groups/

API endpoint for managing groups.

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].name (string) – (required)

  • results[].permissions[] (string) –

  • results[].users (string) – (required)

POST /groups/

API endpoint for managing groups.

Request JSON Object

  • name (string) – (required)

  • permissions[] (string) –

  • users (string) – (required)

Status Codes
Response JSON Object

  • name (string) – (required)

  • permissions[] (string) –

  • users (string) – (required)

GET /groups/{id}/

API endpoint for managing groups.

Parameters

  • id (string) –

Status Codes
Response JSON Object

  • name (string) – (required)

  • permissions[] (string) –

  • users (string) – (required)

PATCH /groups/{id}/

API endpoint for managing groups.

Parameters

  • id (string) –

Request JSON Object

  • name (string) – (required)

  • permissions[] (string) –

  • users (string) – (required)

Status Codes
Response JSON Object

  • name (string) – (required)

  • permissions[] (string) –

  • users (string) – (required)

DELETE /groups/{id}/

API endpoint for managing groups.

Parameters

  • id (string) –

Status Codes
GET /health/
Status Codes
GET /ipaddresses/

API endpoint for managing IP addresses.

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

  • datastore_id (integer) – Data store ID that the IP is assigned to

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].datastore.id (integer) – (read only)

  • results[].datastore.name (string) – DataStore Name (required)

  • results[].datastore.url (string) – (read only)

  • results[].id (integer) – (read only)

  • results[].ipaddr (string) – IP Address (IPv4) (required)

  • results[].url (string) – (read only)

POST /ipaddresses/

API endpoint for managing IP addresses.

Request JSON Object

  • datastore (integer) – (required)

  • id (integer) – (read only)

  • ipaddr (string) – (required)

  • url (string) – (read only)

Status Codes
Response JSON Object

  • datastore (integer) – (required)

  • id (integer) – (read only)

  • ipaddr (string) – (required)

  • url (string) – (read only)

GET /ipaddresses/{id}/

API endpoint for managing IP addresses.

Parameters

  • id (string) –

Status Codes
Response JSON Object

  • datastore.id (integer) – (read only)

  • datastore.name (string) – DataStore Name (required)

  • datastore.url (string) – (read only)

  • id (integer) – (read only)

  • ipaddr (string) – IP Address (IPv4) (required)

  • url (string) – (read only)

PATCH /ipaddresses/{id}/

API endpoint for managing IP addresses.

Parameters

  • id (string) –

Request JSON Object

  • datastore (integer) – (required)

  • id (integer) – (read only)

  • ipaddr (string) – (required)

  • url (string) – (read only)

Status Codes
Response JSON Object

  • datastore (integer) – (required)

  • id (integer) – (read only)

  • ipaddr (string) – (required)

  • url (string) – (read only)

DELETE /ipaddresses/{id}/

API endpoint for managing IP addresses.

Parameters

  • id (string) –

Status Codes
GET /jobs/

API endpoint for managing jobs.

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

  • created (string) – Time period string for filtering jobs by time. Leave null for displaying jobs in all times.

  • created_time_from (string) – Start time for filtering jobs by creation time in UTC. Discarded when created parameter is given.

  • created_time_to (string) – End time for filtering jobs by creation time in UTC. Discarded when created parameter is given.

  • completed_time_from (string) – Start time for filtering jobs by completion time in UTC.

  • completed_time_to (string) – End time for filtering jobs by completion time in UTC.

  • jobtype (string) – Job type

  • state (array) – Job states

  • owner_ids (array) – Job owner user IDs. Send -1 for the Unknown owner.

  • clientkey_ids (array) – Job clientkey IDs

  • schedule_ids (array) – Job schedule IDs

  • site_id (integer) – Job site ID

  • input_paths_prefix (string) – Path prefix for the job input paths

  • hide_noop (boolean) – Hide successful jobs with no processed files

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].clientkey (string) – (read only)

  • results[].completed (string) – Time of the job completion

  • results[].created (string) – Time of the job creation

  • results[].dir_walk_complete (string) – (read only)

  • results[].fields (object) –

  • results[].id (integer) – (read only)

  • results[].jobtype (string) – (required)

  • results[].numabortedfiles (integer) –

  • results[].numcancelledfiles (integer) –

  • results[].numfailedfiles (integer) –

  • results[].numfiles (integer) –

  • results[].numprocessedfiles (integer) –

  • results[].numskippedfiles (integer) –

  • results[].owner (string) – (read only)

  • results[].runtime (number) –

  • results[].schedule (string) – (read only)

  • results[].site (string) – Site Name (required)

  • results[].started (string) – Time the job started executing

  • results[].state (string) –

  • results[].url (string) – (read only)

POST /jobs/

API endpoint for managing jobs.

Request JSON Object

  • discovery (string) – Path discovery method

  • jobtype (string) – (required)

  • paths[] (string) –

  • site (string) – Site Name (required)

  • state (string) –

Status Codes
Response JSON Object

  • discovery (string) – Path discovery method

  • jobtype (string) – (required)

  • paths[] (string) –

  • site (string) – Site Name (required)

  • state (string) –

GET /jobs/recent/

Retrieves last N jobs as recent jobs. N = 5 by default (defined in dynamohub/settings/base.py).

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].clientkey (string) – (read only)

  • results[].completed (string) – Time of the job completion

  • results[].created (string) – Time of the job creation

  • results[].dir_walk_complete (string) – (read only)

  • results[].discovery (string) – Path discovery method

  • results[].fields (object) –

  • results[].id (integer) – (read only)

  • results[].jobtype (string) – (required)

  • results[].numabortedfiles (integer) –

  • results[].numcancelledfiles (integer) –

  • results[].numfailedfiles (integer) –

  • results[].numfiles (integer) –

  • results[].numprocessedfiles (integer) –

  • results[].numskippedfiles (integer) –

  • results[].owner (string) – (read only)

  • results[].paths (string) – (read only)

  • results[].runtime (number) –

  • results[].schedule (string) – (read only)

  • results[].site (string) – Site Name (required)

  • results[].started (string) – Time the job started executing

  • results[].state (string) –

  • results[].url (string) – (read only)

GET /jobs/stats/

API endpoint for managing jobs.

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

  • created (string) – Time period string for filtering jobs by time. Leave null for displaying jobs in all times.

  • created_time_from (string) – Start time for filtering jobs by creation time in UTC. Discarded when created parameter is given.

  • created_time_to (string) – End time for filtering jobs by creation time in UTC. Discarded when created parameter is given.

  • completed_time_from (string) – Start time for filtering jobs by completion time in UTC.

  • completed_time_to (string) – End time for filtering jobs by completion time in UTC.

  • jobtype (string) – Job type

  • state (array) – Job states

  • owner_ids (array) – Job owner user IDs. Send -1 for the Unknown owner.

  • clientkey_ids (array) – Job clientkey IDs

  • schedule_ids (array) – Job schedule IDs

  • site_id (integer) – Job site ID

  • input_paths_prefix (string) – Path prefix for the job input paths

  • hide_noop (boolean) – Hide successful jobs with no processed files

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].clientkey (string) – (read only)

  • results[].completed (string) – Time of the job completion

  • results[].created (string) – Time of the job creation

  • results[].dir_walk_complete (string) – (read only)

  • results[].discovery (string) – Path discovery method

  • results[].fields (object) –

  • results[].id (integer) – (read only)

  • results[].jobtype (string) – (required)

  • results[].numabortedfiles (integer) –

  • results[].numcancelledfiles (integer) –

  • results[].numfailedfiles (integer) –

  • results[].numfiles (integer) –

  • results[].numprocessedfiles (integer) –

  • results[].numskippedfiles (integer) –

  • results[].owner (string) – (read only)

  • results[].paths (string) – (read only)

  • results[].runtime (number) –

  • results[].schedule (string) – (read only)

  • results[].site (string) – Site Name (required)

  • results[].started (string) – Time the job started executing

  • results[].state (string) –

  • results[].url (string) – (read only)

GET /jobs/{id}/

API endpoint for managing jobs.

Parameters

  • id (string) –

Status Codes
Response JSON Object

  • clientkey (string) – (read only)

  • completed (string) – Time of the job completion

  • created (string) – Time of the job creation

  • dir_walk_complete (string) – (read only)

  • discovery (string) – Path discovery method

  • fields (object) –

  • id (integer) – (read only)

  • jobtype (string) – (required)

  • numabortedfiles (integer) –

  • numcancelledfiles (integer) –

  • numfailedfiles (integer) –

  • numfiles (integer) –

  • numprocessedfiles (integer) –

  • numskippedfiles (integer) –

  • owner (string) – (read only)

  • paths (string) – (read only)

  • runtime (number) –

  • schedule (string) – (read only)

  • site (string) – Site Name (required)

  • started (string) – Time the job started executing

  • state (string) –

  • url (string) – (read only)

PATCH /jobs/{id}/

API endpoint for managing jobs.

Parameters

  • id (string) –

Request JSON Object

  • discovery (string) – Path discovery method

  • jobtype (string) – (required)

  • paths[] (string) –

  • site (string) – Site Name (required)

  • state (string) –

Status Codes
Response JSON Object

  • discovery (string) – Path discovery method

  • jobtype (string) – (required)

  • paths[] (string) –

  • site (string) – Site Name (required)

  • state (string) –

DELETE /jobs/{id}/

API endpoint for managing jobs.

Parameters

  • id (string) –

Status Codes
POST /jobs/{id}/cancel/

Cancels the pending and started tasks currently on the MQ for the given ID’s job.

Parameters

  • id (string) –

Status Codes
Response JSON Object

  • clientkey (string) – (read only)

  • completed (string) – Time of the job completion

  • created (string) – Time of the job creation

  • dir_walk_complete (string) – (read only)

  • discovery (string) – Path discovery method

  • fields (object) –

  • id (integer) – (read only)

  • jobtype (string) – (required)

  • numabortedfiles (integer) –

  • numcancelledfiles (integer) –

  • numfailedfiles (integer) –

  • numfiles (integer) –

  • numprocessedfiles (integer) –

  • numskippedfiles (integer) –

  • owner (string) – (read only)

  • paths (string) – (read only)

  • runtime (number) –

  • schedule (string) – (read only)

  • site (string) – Site Name (required)

  • started (string) – Time the job started executing

  • state (string) –

  • url (string) – (read only)

GET /jobs/{id}/files/

Retrieves the files related with a job, with their execution status.

Parameters

  • id (string) –

Query Parameters

  • category (string) –

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • clientkey (string) – (read only)

  • completed (string) – Time of the job completion

  • created (string) – Time of the job creation

  • dir_walk_complete (string) – (read only)

  • discovery (string) – Path discovery method

  • fields (object) –

  • id (integer) – (read only)

  • jobtype (string) – (required)

  • numabortedfiles (integer) –

  • numcancelledfiles (integer) –

  • numfailedfiles (integer) –

  • numfiles (integer) –

  • numprocessedfiles (integer) –

  • numskippedfiles (integer) –

  • owner (string) – (read only)

  • paths (string) – (read only)

  • runtime (number) –

  • schedule (string) – (read only)

  • site (string) – Site Name (required)

  • started (string) – Time the job started executing

  • state (string) –

  • url (string) – (read only)

POST /jobs/{id}/resubmit/

Resubmits the job with given id. If the job is not finished yet, this action will not have an effect.

Parameters

  • id (string) –

Status Codes
GET /nodes/
Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].id (integer) – (read only)

  • results[].last_heartbeat (string) – Time the node sent its last heartbeat event

  • results[].name (string) – Hostname for a given worker node (required)

  • results[].online (string) – (read only)

  • results[].site (string) – (required)

  • results[].url (string) – (read only)

GET /nodes/{id}/
Parameters

  • id (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • last_heartbeat (string) – Time the node sent its last heartbeat event

  • name (string) – Hostname for a given worker node (required)

  • online (string) – (read only)

  • site (string) – (required)

  • url (string) – (read only)

PATCH /nodes/{id}/
Parameters

  • id (string) –

Request JSON Object

  • id (integer) – (read only)

  • last_heartbeat (string) – Time the node sent its last heartbeat event

  • name (string) – Hostname for a given worker node (required)

  • online (string) – (read only)

  • site (string) – (required)

  • url (string) – (read only)

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • last_heartbeat (string) – Time the node sent its last heartbeat event

  • name (string) – Hostname for a given worker node (required)

  • online (string) – (read only)

  • site (string) – (required)

  • url (string) – (read only)

DELETE /nodes/{id}/
Parameters

  • id (string) –

Status Codes
GET /pki/ca/pub/
Status Codes
GET /pki/redis/private/
Status Codes
GET /pki/redis/pub/
Status Codes
POST /pki/site/
Status Codes
GET /schedules/
Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].day_of_month (string) – The day setting for the cron schedule

  • results[].day_of_week (string) – The week setting for the cron schedule

  • results[].discovery (string) –

  • results[].discovery_options (object) –

  • results[].enabled (boolean) – If the schedule should be enabled

  • results[].hour (string) – The hour setting for the cron schedule

  • results[].id (integer) – (read only)

  • results[].managed_paths (object) – Path of managed filesystem elements

  • results[].minute (string) – The minute setting for the cron schedule

  • results[].month_of_year (string) – The month setting for the cron schedule

  • results[].name (string) – Schedule Name (required)

  • results[].site (string) – (required)

  • results[].url (string) – (read only)

POST /schedules/
Request JSON Object

  • day_of_month (string) – The day setting for the cron schedule

  • day_of_week (string) – The week setting for the cron schedule

  • discovery (string) –

  • discovery_options (object) –

  • enabled (boolean) – If the schedule should be enabled

  • hour (string) – The hour setting for the cron schedule

  • id (integer) – (read only)

  • managed_paths (object) – Path of managed filesystem elements

  • minute (string) – The minute setting for the cron schedule

  • month_of_year (string) – The month setting for the cron schedule

  • name (string) – Schedule Name (required)

  • site (string) – (required)

  • url (string) – (read only)

Status Codes
Response JSON Object

  • day_of_month (string) – The day setting for the cron schedule

  • day_of_week (string) – The week setting for the cron schedule

  • discovery (string) –

  • discovery_options (object) –

  • enabled (boolean) – If the schedule should be enabled

  • hour (string) – The hour setting for the cron schedule

  • id (integer) – (read only)

  • managed_paths (object) – Path of managed filesystem elements

  • minute (string) – The minute setting for the cron schedule

  • month_of_year (string) – The month setting for the cron schedule

  • name (string) – Schedule Name (required)

  • site (string) – (required)

  • url (string) – (read only)

GET /schedules/{id}/
Parameters

  • id (string) –

Status Codes
Response JSON Object

  • day_of_month (string) – The day setting for the cron schedule

  • day_of_week (string) – The week setting for the cron schedule

  • discovery (string) –

  • discovery_options (object) –

  • enabled (boolean) – If the schedule should be enabled

  • hour (string) – The hour setting for the cron schedule

  • id (integer) – (read only)

  • managed_paths (object) – Path of managed filesystem elements

  • minute (string) – The minute setting for the cron schedule

  • month_of_year (string) – The month setting for the cron schedule

  • name (string) – Schedule Name (required)

  • site (string) – (required)

  • url (string) – (read only)

PATCH /schedules/{id}/
Parameters

  • id (string) –

Request JSON Object

  • day_of_month (string) – The day setting for the cron schedule

  • day_of_week (string) – The week setting for the cron schedule

  • discovery (string) –

  • discovery_options (object) –

  • enabled (boolean) – If the schedule should be enabled

  • hour (string) – The hour setting for the cron schedule

  • id (integer) – (read only)

  • managed_paths (object) – Path of managed filesystem elements

  • minute (string) – The minute setting for the cron schedule

  • month_of_year (string) – The month setting for the cron schedule

  • name (string) – Schedule Name (required)

  • site (string) – (required)

Status Codes
Response JSON Object

  • day_of_month (string) – The day setting for the cron schedule

  • day_of_week (string) – The week setting for the cron schedule

  • discovery (string) –

  • discovery_options (object) –

  • enabled (boolean) – If the schedule should be enabled

  • hour (string) – The hour setting for the cron schedule

  • id (integer) – (read only)

  • managed_paths (object) – Path of managed filesystem elements

  • minute (string) – The minute setting for the cron schedule

  • month_of_year (string) – The month setting for the cron schedule

  • name (string) – Schedule Name (required)

  • site (string) – (required)

DELETE /schedules/{id}/
Parameters

  • id (string) –

Status Codes
GET /schedules/{parent_lookup_schedule}/workflows/
Parameters

  • parent_lookup_schedule (string) –

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].fields (object) – Mapping of path to operation for task usage

  • results[].id (integer) – (read only)

  • results[].site (string) – (required)

  • results[].url (string) – (read only)

  • results[].workflow (string) – (required)

POST /schedules/{parent_lookup_schedule}/workflows/
Parameters

  • parent_lookup_schedule (string) –

Request JSON Object

  • fields (object) – Mapping of path to operation for task usage

  • id (integer) – (read only)

  • site (string) – (required)

  • workflow (string) – (required)

Status Codes
Response JSON Object

  • fields (object) – Mapping of path to operation for task usage

  • id (integer) – (read only)

  • site (string) – (required)

  • workflow (string) – (required)

GET /schedules/{parent_lookup_schedule}/workflows/{id}/
Parameters

  • id (string) –

  • parent_lookup_schedule (string) –

Status Codes
Response JSON Object

  • fields (object) – Mapping of path to operation for task usage

  • id (integer) – (read only)

  • site (string) – (required)

  • url (string) – (read only)

  • workflow (string) – (required)

PATCH /schedules/{parent_lookup_schedule}/workflows/{id}/
Parameters

  • id (string) –

  • parent_lookup_schedule (string) –

Request JSON Object

  • fields (object) – Mapping of path to operation for task usage

  • id (integer) – (read only)

  • site (string) – (required)

  • url (string) – (read only)

  • workflow (string) – (required)

Status Codes
Response JSON Object

  • fields (object) – Mapping of path to operation for task usage

  • id (integer) – (read only)

  • site (string) – (required)

  • url (string) – (read only)

  • workflow (string) – (required)

DELETE /schedules/{parent_lookup_schedule}/workflows/{id}/
Parameters

  • id (string) –

  • parent_lookup_schedule (string) –

Status Codes
GET /search/

API endpoint for file search

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].id (integer) – (read only)

  • results[].url (string) – (read only)

POST /search/

API endpoint for file search

Request JSON Object

  • filters (object) – Metadata filters to apply to search

  • merge (boolean) – Whether matching files should be merged

  • metadata_fields (object) – Available metadata fields from this search

  • path (string) – Directory to search (required)

  • recursive (boolean) – Search the target path recursively

  • sites[] (string) –

Status Codes
Response JSON Object

  • filters (object) – Metadata filters to apply to search

  • merge (boolean) – Whether matching files should be merged

  • metadata_fields (object) – Available metadata fields from this search

  • path (string) – Directory to search (required)

  • recursive (boolean) – Search the target path recursively

  • sites[] (string) –

GET /search/metadata_fields/

API endpoint for file search

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].id (integer) – (read only)

  • results[].url (string) – (read only)

GET /search/{id}/

Get paginated results for a given search id.

Parameters

  • id (string) –

Query Parameters

  • page (integer) – Number of the page of results to return

  • page_size (integer) – Number of results to return per page

  • sort (string) – One or more fields to sort results by

Status Codes
Response JSON Object

  • href (string) – (read only)

  • metadata (object) – File metadata

  • name (string) – Directory or file name (required)

  • path (string) – Directory or file path (required)

  • site (string) – Site Name

DELETE /search/{id}/

API endpoint for file search

Parameters

  • id (string) –

Status Codes
GET /sitelinks/

API endpoint for managing sitelinks.

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

  • site_id (integer) – Site ID

  • datastore_id (integer) – Data store ID

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].datastore (string) – (required)

  • results[].datastore_path (string) – (required)

  • results[].id (integer) – (read only)

  • results[].site (string) – (required)

  • results[].site_path (string) – (required)

  • results[].url (string) – (read only)

POST /sitelinks/

API endpoint for managing sitelinks.

Request JSON Object

  • datastore (string) – (required)

  • datastore_path (string) – (required)

  • id (integer) – (read only)

  • site (string) – (required)

  • site_path (string) – (required)

  • url (string) – (read only)

Status Codes
Response JSON Object

  • datastore (string) – (required)

  • datastore_path (string) – (required)

  • id (integer) – (read only)

  • site (string) – (required)

  • site_path (string) – (required)

  • url (string) – (read only)

GET /sitelinks/{id}/

API endpoint for managing sitelinks.

Parameters

  • id (string) –

Status Codes
Response JSON Object

  • datastore (string) – (required)

  • datastore_path (string) – (required)

  • id (integer) – (read only)

  • site (string) – (required)

  • site_path (string) – (required)

  • url (string) – (read only)

PATCH /sitelinks/{id}/

API endpoint for managing sitelinks.

Parameters

  • id (string) –

Request JSON Object

  • datastore (string) – (required)

  • datastore_path (string) – (required)

  • id (integer) – (read only)

  • site (string) – (required)

  • site_path (string) – (required)

  • url (string) – (read only)

Status Codes
Response JSON Object

  • datastore (string) – (required)

  • datastore_path (string) – (required)

  • id (integer) – (read only)

  • site (string) – (required)

  • site_path (string) – (required)

  • url (string) – (read only)

DELETE /sitelinks/{id}/

API endpoint for managing sitelinks.

Parameters

  • id (string) –

Status Codes
GET /sites/

API endpoint for managing sites.

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].id (integer) – (read only)

  • results[].name (string) – Site Name (required)

  • results[].url (string) – (read only)

POST /sites/

API endpoint for managing sites.

Request JSON Object

  • bandwidth (integer) – speed for site (in Mb/s)

  • elasticsearch_url (string) – URL of the Elasticsearch server to use for the Analytics search backend on this site

  • exclude (object) – Global workflow excludes for this site

  • file_batch_gb (integer) – File batch GB

  • file_batch_size (integer) – File batch size

  • gpfs_iscan_buckets (integer) – Number of buckets to use for the gpfs snapdiff policy

  • gpfs_iscan_threads (integer) – Number of threads to use for the gpfs snapdiff policy

  • id (integer) – (read only)

  • include (object) – Global workflow includes for this site

  • lock_threshold (integer) – Threshold for soft locking snapshot rotations

  • name (string) – Site Name (required)

  • pixstor_search_url (string) – The base URL for querying the PixStor API

  • url (string) – (read only)

Status Codes
Response JSON Object

  • bandwidth (integer) – speed for site (in Mb/s)

  • elasticsearch_url (string) – URL of the Elasticsearch server to use for the Analytics search backend on this site

  • exclude (object) – Global workflow excludes for this site

  • file_batch_gb (integer) – File batch GB

  • file_batch_size (integer) – File batch size

  • gpfs_iscan_buckets (integer) – Number of buckets to use for the gpfs snapdiff policy

  • gpfs_iscan_threads (integer) – Number of threads to use for the gpfs snapdiff policy

  • id (integer) – (read only)

  • include (object) – Global workflow includes for this site

  • lock_threshold (integer) – Threshold for soft locking snapshot rotations

  • name (string) – Site Name (required)

  • pixstor_search_url (string) – The base URL for querying the PixStor API

  • url (string) – (read only)

GET /sites/{id}/

API endpoint for managing sites.

Parameters

  • id (string) –

Status Codes
Response JSON Object

  • bandwidth (integer) – speed for site (in Mb/s)

  • elasticsearch_url (string) – URL of the Elasticsearch server to use for the Analytics search backend on this site

  • exclude (object) – Global workflow excludes for this site

  • file_batch_gb (integer) – File batch GB

  • file_batch_size (integer) – File batch size

  • gpfs_iscan_buckets (integer) – Number of buckets to use for the gpfs snapdiff policy

  • gpfs_iscan_threads (integer) – Number of threads to use for the gpfs snapdiff policy

  • id (integer) – (read only)

  • include (object) – Global workflow includes for this site

  • lock_threshold (integer) – Threshold for soft locking snapshot rotations

  • name (string) – Site Name (required)

  • pixstor_search_url (string) – The base URL for querying the PixStor API

  • url (string) – (read only)

PATCH /sites/{id}/

API endpoint for managing sites.

Parameters

  • id (string) –

Request JSON Object

  • bandwidth (integer) – speed for site (in Mb/s)

  • elasticsearch_url (string) – URL of the Elasticsearch server to use for the Analytics search backend on this site

  • exclude (object) – Global workflow excludes for this site

  • file_batch_gb (integer) – File batch GB

  • file_batch_size (integer) – File batch size

  • gpfs_iscan_buckets (integer) – Number of buckets to use for the gpfs snapdiff policy

  • gpfs_iscan_threads (integer) – Number of threads to use for the gpfs snapdiff policy

  • id (integer) – (read only)

  • include (object) – Global workflow includes for this site

  • lock_threshold (integer) – Threshold for soft locking snapshot rotations

  • name (string) – Site Name (required)

  • pixstor_search_url (string) – The base URL for querying the PixStor API

  • url (string) – (read only)

Status Codes
Response JSON Object

  • bandwidth (integer) – speed for site (in Mb/s)

  • elasticsearch_url (string) – URL of the Elasticsearch server to use for the Analytics search backend on this site

  • exclude (object) – Global workflow excludes for this site

  • file_batch_gb (integer) – File batch GB

  • file_batch_size (integer) – File batch size

  • gpfs_iscan_buckets (integer) – Number of buckets to use for the gpfs snapdiff policy

  • gpfs_iscan_threads (integer) – Number of threads to use for the gpfs snapdiff policy

  • id (integer) – (read only)

  • include (object) – Global workflow includes for this site

  • lock_threshold (integer) – Threshold for soft locking snapshot rotations

  • name (string) – Site Name (required)

  • pixstor_search_url (string) – The base URL for querying the PixStor API

  • url (string) – (read only)

DELETE /sites/{id}/

API endpoint for managing sites.

Parameters

  • id (string) –

Status Codes
GET /sites/{id}/health/

API endpoint for managing sites.

Parameters

  • id (string) –

Status Codes
Response JSON Object

  • bandwidth (integer) – speed for site (in Mb/s)

  • elasticsearch_url (string) – URL of the Elasticsearch server to use for the Analytics search backend on this site

  • exclude (object) – Global workflow excludes for this site

  • file_batch_gb (integer) – File batch GB

  • file_batch_size (integer) – File batch size

  • gpfs_iscan_buckets (integer) – Number of buckets to use for the gpfs snapdiff policy

  • gpfs_iscan_threads (integer) – Number of threads to use for the gpfs snapdiff policy

  • id (integer) – (read only)

  • include (object) – Global workflow includes for this site

  • lock_threshold (integer) – Threshold for soft locking snapshot rotations

  • name (string) – Site Name (required)

  • pixstor_search_url (string) – The base URL for querying the PixStor API

  • url (string) – (read only)

GET /tasks/

API endpoint for viewing tasks.

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

  • tasktype (string) – Task type

  • state (array) – Task states

  • job_id (integer) – Job ID

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].job (integer) – (required)

  • results[].site (string) – (required)

  • results[].started (string) – Time that the task started running

  • results[].state (string) – (required)

  • results[].taskid (string) – Job task ID (required)

  • results[].tasktype (string) – (required)

  • results[].url (string) – (read only)

GET /tasks/{taskid}/

API endpoint for viewing tasks.

Parameters

  • taskid (string) –

Status Codes
Response JSON Object

  • completed (string) – Time of the task completion

  • job (integer) – (required)

  • moved_data (integer) –

  • numabortedfiles (integer) –

  • numcancelledfiles (integer) –

  • numfailedfiles (integer) –

  • numfiles (integer) –

  • numprocessedfiles (integer) –

  • numskippedfiles (integer) –

  • paths (string) – (read only)

  • results (string) – (read only)

  • runtime (string) – (read only)

  • site (string) – (required)

  • started (string) – Time that the task started running

  • state (string) – (required)

  • taskid (string) – Job task ID (required)

  • tasktype (string) – (required)

  • url (string) – (read only)

GET /tasks/{taskid}/files/

API endpoint for viewing tasks.

Parameters

  • taskid (string) –

Query Parameters

  • state (string) –

  • type (string) –

  • site (string) –

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • completed (string) – Time of the task completion

  • job (integer) – (required)

  • moved_data (integer) –

  • numabortedfiles (integer) –

  • numcancelledfiles (integer) –

  • numfailedfiles (integer) –

  • numfiles (integer) –

  • numprocessedfiles (integer) –

  • numskippedfiles (integer) –

  • paths (string) – (read only)

  • results (string) – (read only)

  • runtime (string) – (read only)

  • site (string) – (required)

  • started (string) – Time that the task started running

  • state (string) – (required)

  • taskid (string) – Job task ID (required)

  • tasktype (string) – (required)

  • url (string) – (read only)

GET /users/

API endpoint for managing users.

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].date_joined (string) –

  • results[].email (string) –

  • results[].first_name (string) –

  • results[].groups[].id (integer) – (read only)

  • results[].groups[].name (string) – (required)

  • results[].groups[].url (string) – (read only)

  • results[].id (integer) – (read only)

  • results[].is_active (boolean) – Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

  • results[].last_login (string) –

  • results[].last_name (string) –

  • results[].url (string) – (read only)

  • results[].username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

POST /users/

API endpoint for managing users.

Request JSON Object

  • email (string) –

  • first_name (string) –

  • groups[] (string) –

  • last_name (string) –

  • password (string) – (required)

  • username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • email (string) –

  • first_name (string) –

  • groups[] (string) –

  • last_name (string) –

  • password (string) – (required)

  • username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

GET /users/{username}/

API endpoint for managing users.

Parameters

  • username (string) –

Status Codes
Response JSON Object

  • date_joined (string) –

  • email (string) –

  • first_name (string) –

  • groups[].id (integer) – (read only)

  • groups[].name (string) – (required)

  • groups[].url (string) – (read only)

  • id (integer) – (read only)

  • is_active (boolean) – Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

  • last_login (string) –

  • last_name (string) –

  • url (string) – (read only)

  • username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

PATCH /users/{username}/

API endpoint for managing users.

Parameters

  • username (string) –

Request JSON Object

  • email (string) –

  • first_name (string) –

  • groups[] (string) –

  • last_name (string) –

  • password (string) –

Status Codes
Response JSON Object

  • email (string) –

  • first_name (string) –

  • groups[] (string) –

  • last_name (string) –

  • password (string) –

DELETE /users/{username}/

API endpoint for managing users.

Parameters

  • username (string) –

Status Codes
POST /users/{username}/activate/

Activates user account with given username.

Parameters

  • username (string) –

Status Codes
POST /users/{username}/deactivate/

Deactivates user account with given username.

Parameters

  • username (string) –

Status Codes
GET /workflows/

API endpoint for viewing workflows.

Query Parameters

  • page (integer) – A page number within the paginated result set. When not given, first page is retrieved by default.

  • page_size (integer) – Number of results to return per page. Page size parameter can be a number between 20 and 100. For disabling pagination and retrieving all results, 0 should be given. When page size parameter is empty or <20, 20 results are returned by default. When page size parameter >100, 100 results are returned by default.

Status Codes
Response JSON Object

  • count (integer) – (required)

  • next (string) –

  • previous (string) –

  • results[].allow_missing_paths (boolean) – To allow paths that does not exist

  • results[].discovery (string) –

  • results[].discovery_options (object) –

  • results[].enabled (boolean) – Is the workflow available for use?

  • results[].fields (object) –

  • results[].filter_rules (object) –

  • results[].icon_classes (object) –

  • results[].id (integer) – (read only)

  • results[].label (string) – Friendly name of the workflow (required)

  • results[].name (string) – Name of Workflow (required)

  • results[].schedule_only (boolean) – Workflow only callable inside of a schedule

  • results[].visible (boolean) – Is the workflow visible on the UI?

POST /workflows/

API endpoint for viewing workflows.

Request JSON Object

  • allow_missing_paths (boolean) – To allow paths that does not exist

  • discovery (string) –

  • discovery_options (object) –

  • enabled (boolean) – Is the workflow available for use?

  • fields (object) –

  • filter_rules (object) –

  • icon_classes (object) –

  • id (integer) – (read only)

  • label (string) – Friendly name of the workflow (required)

  • name (string) – Name of Workflow (required)

  • schedule_only (boolean) – Workflow only callable inside of a schedule

  • visible (boolean) – Is the workflow visible on the UI?

Status Codes
Response JSON Object

  • allow_missing_paths (boolean) – To allow paths that does not exist

  • discovery (string) –

  • discovery_options (object) –

  • enabled (boolean) – Is the workflow available for use?

  • fields (object) –

  • filter_rules (object) –

  • icon_classes (object) –

  • id (integer) – (read only)

  • label (string) – Friendly name of the workflow (required)

  • name (string) – Name of Workflow (required)

  • schedule_only (boolean) – Workflow only callable inside of a schedule

  • visible (boolean) – Is the workflow visible on the UI?

GET /workflows/{id}/

API endpoint for viewing workflows.

Parameters

  • id (string) –

Status Codes
Response JSON Object

  • allow_missing_paths (boolean) – To allow paths that does not exist

  • discovery (string) –

  • discovery_options (object) –

  • enabled (boolean) – Is the workflow available for use?

  • fields (object) –

  • filter_rules (object) –

  • icon_classes (object) –

  • id (integer) – (read only)

  • label (string) – Friendly name of the workflow (required)

  • name (string) – Name of Workflow (required)

  • schedule_only (boolean) – Workflow only callable inside of a schedule

  • visible (boolean) – Is the workflow visible on the UI?

PATCH /workflows/{id}/

API endpoint for viewing workflows.

Parameters

  • id (string) –

Request JSON Object

  • allow_missing_paths (boolean) – To allow paths that does not exist

  • discovery (string) –

  • discovery_options (object) –

  • enabled (boolean) – Is the workflow available for use?

  • fields (object) –

  • filter_rules (object) –

  • icon_classes (object) –

  • id (integer) – (read only)

  • label (string) – Friendly name of the workflow (required)

  • name (string) – Name of Workflow (required)

  • schedule_only (boolean) – Workflow only callable inside of a schedule

  • visible (boolean) – Is the workflow visible on the UI?

Status Codes
Response JSON Object

  • allow_missing_paths (boolean) – To allow paths that does not exist

  • discovery (string) –

  • discovery_options (object) –

  • enabled (boolean) – Is the workflow available for use?

  • fields (object) –

  • filter_rules (object) –

  • icon_classes (object) –

  • id (integer) – (read only)

  • label (string) – Friendly name of the workflow (required)

  • name (string) – Name of Workflow (required)

  • schedule_only (boolean) – Workflow only callable inside of a schedule

  • visible (boolean) – Is the workflow visible on the UI?

DELETE /workflows/{id}/

API endpoint for viewing workflows.

Parameters

  • id (string) –

Status Codes