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 /alerts/
Query Parameters

  • name (string) -- name

  • node (string) -- node

  • site (string) -- site

  • severity (string) -- severity

  • summary (string) -- summary

  • timestamp (string) -- timestamp

  • suppressed (string) -- suppressed

Status Codes
Response JSON Object

  • [].created (string) -- Time that the alert was recorded in Hub

  • [].id (integer) -- (read only)

  • [].name (string) -- Name of of the alert (required)

  • [].node (string) -- Hostname of the node the alert originated from

  • [].severity (string) -- (required)

  • [].site (string) -- (read only)

  • [].summary (string) -- Summary description of the alert

  • [].suppressed (boolean) -- Whether the alert is suppressed

  • [].timestamp (string) -- Time when the alert was triggered (required)

GET /alerts/{id}/
Parameters

  • id (integer) -- A unique integer value identifying this alert.

Status Codes
Response JSON Object

  • created (string) -- Time that the alert was recorded in Hub

  • id (integer) -- (read only)

  • name (string) -- Name of of the alert (required)

  • node (string) -- Hostname of the node the alert originated from

  • severity (string) -- (required)

  • site (string) -- (read only)

  • summary (string) -- Summary description of the alert

  • suppressed (boolean) -- Whether the alert is suppressed

  • timestamp (string) -- Time when the alert was triggered (required)

GET /analytics/

Retrieves list of files under given path for given site.

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.

  • path (string) -- Target directory path

  • site (string) -- Site name

  • children (boolean) -- Include children directories

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

  • custom_timeout (integer) -- Timeout for fetching analytics

  • download (string) -- Download details as file e.g. CSV ?download=csv.

Status Codes
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)

  • results[].user (string) -- (required)

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)

  • user (string) -- (required)

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)

  • user (string) -- (read only)

Status Codes
Response JSON Object

  • id (integer) -- (read only)

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

  • url (string) -- (read only)

  • user (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

  • analytics_timeout (integer) -- Maximum time to wait for results from analytics in seconds

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

  • force_local_managed_users (boolean) -- Allow NAS users to be managed on AD joined sites

  • 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

  • analytics_timeout (integer) -- Maximum time to wait for results from analytics in seconds

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

  • force_local_managed_users (boolean) -- Allow NAS users to be managed on AD joined sites

  • 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

  • analytics_timeout (integer) -- Maximum time to wait for results from analytics in seconds

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

  • force_local_managed_users (boolean) -- Allow NAS users to be managed on AD joined sites

  • 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

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

  • path (string) -- Target directory path

  • site (string) -- Site name

  • details (boolean) -- Show details of children objects

  • restricted (boolean) -- Include restricted 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 /filesystems/
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[].mountpoint (string) -- Filesystem mount point (required)

  • results[].name (string) -- Name of the filesystem (required)

  • results[].site (string) -- Site the filesystem belongs to (required)

GET /filesystems/{id}/
Parameters

  • id (string) --

Status Codes
Response JSON Object

  • mountpoint (string) -- Filesystem mount point (required)

  • name (string) -- Name of the filesystem (required)

  • site (string) -- Site the filesystem belongs to (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[].description (string) -- (read only)

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

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

  • results[].nas_group.gid (integer) -- GID number for the user. This is automatically generated and cannot be changed. (read only)

  • results[].object_permissions[].model (string) -- (required)

  • results[].object_permissions[].object_pk (string) -- (required)

  • results[].object_permissions[].permission (integer) -- (required)

  • results[].permissions[] (integer) --

  • results[].users[].date_joined (string) --

  • results[].users[].email (string) --

  • results[].users[].first_name (string) --

  • results[].users[].last_login (string) --

  • results[].users[].last_name (string) --

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

POST /groups/

API endpoint for managing groups.

Request JSON Object

  • description (string) --

  • id (integer) -- (read only)

  • name (string) -- (required)

  • nas_group (boolean) --

  • object_permissions[].model (string) -- (required)

  • object_permissions[].object_pk (string) -- (required)

  • object_permissions[].permission (integer) -- (required)

  • permissions[] (integer) --

  • users[] (string) --

Status Codes
Response JSON Object

  • description (string) --

  • id (integer) -- (read only)

  • name (string) -- (required)

  • nas_group (boolean) --

  • object_permissions[].model (string) -- (required)

  • object_permissions[].object_pk (string) -- (required)

  • object_permissions[].permission (integer) -- (required)

  • permissions[] (integer) --

  • users[] (string) --

GET /groups/{id}/

API endpoint for managing groups.

Parameters

  • id (string) --

Status Codes
Response JSON Object

  • description (string) -- (read only)

  • id (integer) -- (read only)

  • name (string) -- (required)

  • nas_group.gid (integer) -- GID number for the user. This is automatically generated and cannot be changed. (read only)

  • object_permissions[].model (string) -- (required)

  • object_permissions[].object_pk (string) -- (required)

  • object_permissions[].permission (integer) -- (required)

  • permissions[] (integer) --

  • users[].date_joined (string) --

  • users[].email (string) --

  • users[].first_name (string) --

  • users[].last_login (string) --

  • users[].last_name (string) --

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

PATCH /groups/{id}/

API endpoint for managing groups.

Parameters

  • id (string) --

Request JSON Object

  • description (string) --

  • id (integer) -- (read only)

  • name (string) -- (required)

  • nas_group (boolean) --

  • object_permissions[].model (string) -- (required)

  • object_permissions[].object_pk (string) -- (required)

  • object_permissions[].permission (integer) -- (required)

  • permissions[] (integer) --

  • users[] (string) --

Status Codes
Response JSON Object

  • description (string) --

  • id (integer) -- (read only)

  • name (string) -- (required)

  • nas_group (boolean) --

  • object_permissions[].model (string) -- (required)

  • object_permissions[].object_pk (string) -- (required)

  • object_permissions[].permission (integer) -- (required)

  • permissions[] (integer) --

  • users[] (string) --

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.

  • workflow (string) -- Job workflow type

  • state (array) -- Job states

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

  • clientkey_ids (array) -- Job clientkey IDs

  • schedule_ids (array) -- Job schedule IDs

  • site (string) -- Job site name

  • site_id (integer) -- Job site ID

  • input_paths_prefix (string) -- Path prefix for the job paths

  • search_keyword (string) -- Keyword to filter by

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

Status Codes
POST /jobs/

API endpoint for managing jobs.

Status Codes
GET /jobs/jobtype_choices/

Get all custom jobtypes.

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

  • workflow (string) -- Job workflow type

  • state (array) -- Job states

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

  • clientkey_ids (array) -- Job clientkey IDs

  • schedule_ids (array) -- Job schedule IDs

  • site (string) -- Job site name

  • site_id (integer) -- Job site ID

  • input_paths_prefix (string) -- Path prefix for the job paths

  • search_keyword (string) -- Keyword to filter by

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

Status Codes
GET /jobs/{id}/

API endpoint for managing jobs.

Parameters

  • id (string) --

Status Codes
PATCH /jobs/{id}/

API endpoint for managing jobs.

Parameters

  • id (string) --

Status Codes
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
GET /jobs/{id}/files/

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

Parameters

  • id (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.

  • category (string) --

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

API endpoint to pause the active dag job

Parameters

  • id (string) --

Status Codes
GET /jobs/{id}/progress/

Returns the job completion percentage for the given job id

Parameters

  • id (string) --

Status Codes
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
POST /jobs/{id}/resume/

API endpoint to resume the paused dag job

Parameters

  • id (string) --

Status Codes
GET /jobs/{id}/statistics/

Returns the statistics of all files for the given job id

Parameters

  • id (string) --

Status Codes
GET /jobstats/

API endpoint for managing jobstat.

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.

  • state (array) -- Job states

  • job (integer) -- Job ID

  • path (string) -- Target path

  • history (boolean) -- Returns the task history along with job stat

Status Codes
Response JSON Object

  • count (integer) -- (required)

  • next (string) --

  • previous (string) --

  • results[].code (string) --

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

  • results[].job (integer) -- Related job id (required)

  • results[].message (string) --

  • results[].path (string) -- Path to object on filesystem

  • results[].state (string) --

  • results[].task (integer) -- Latest related dag task (required)

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

GET /jobstats/{id}/

API endpoint for managing jobstat.

Parameters

  • id (string) --

Status Codes
Response JSON Object

  • code (string) --

  • id (integer) -- (read only)

  • job (integer) -- Related job id (required)

  • message (string) --

  • path (string) -- Path to object on filesystem

  • state (string) --

  • task (integer) -- Latest related dag task (required)

GET /jobstats/{id}/history/

Returns the task history for the job stat ID

Parameters

  • id (string) --

Query Parameters

  • state (array) -- Job states

  • job (integer) -- Job ID

  • path (string) -- Target path

  • history (boolean) -- Returns the task history along with job stat

Status Codes
Response JSON Object

  • code (string) --

  • id (integer) -- (read only)

  • job (integer) -- Related job id (required)

  • message (string) --

  • path (string) -- Path to object on filesystem

  • state (string) --

  • task (integer) -- Latest related dag task (required)

GET /my-permissions/

API endpoint for viewing the requesting user permissions.

Status Codes
Response JSON Object

  • [].group_object_permissions.app_label (string) -- (required)

  • [].group_object_permissions.codename (string) -- (required)

  • [].group_object_permissions.id (integer) -- (required)

  • [].group_object_permissions.model (string) -- (required)

  • [].group_object_permissions.name (string) -- (required)

  • [].group_object_permissions.object_pk (string) -- (required)

  • [].group_permissions.app_label (string) -- (required)

  • [].group_permissions.codename (string) -- (required)

  • [].group_permissions.id (integer) -- (read only)

  • [].group_permissions.model (string) -- (required)

  • [].group_permissions.name (string) -- (required)

  • [].user_object_permissions.app_label (string) -- (required)

  • [].user_object_permissions.codename (string) -- (required)

  • [].user_object_permissions.id (integer) -- (required)

  • [].user_object_permissions.model (string) -- (required)

  • [].user_object_permissions.name (string) -- (required)

  • [].user_object_permissions.object_pk (string) -- (required)

  • [].user_permissions.app_label (string) -- (required)

  • [].user_permissions.codename (string) -- (required)

  • [].user_permissions.id (integer) -- (read only)

  • [].user_permissions.model (string) -- (required)

  • [].user_permissions.name (string) -- (required)

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 /permissions/

API endpoint for viewing permissions.

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[].app_label (string) -- (required)

  • results[].codename (string) -- (required)

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

  • results[].model (string) -- (required)

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

GET /permissions/{id}/

API endpoint for viewing permissions.

Parameters

  • id (string) --

Status Codes
Response JSON Object

  • app_label (string) -- (required)

  • codename (string) -- (required)

  • id (integer) -- (read only)

  • model (string) -- (required)

  • name (string) -- (required)

GET /pki/ca/pub/
Status Codes
GET /pki/lifetime/
Status Codes
Response JSON Object

  • [].days (integer) -- The number of days the certificate is valid for.

  • [].updated_at (string) -- (read only)

  • [].updated_by (integer) -- (read only)

GET /pki/lifetime/{id}/
Parameters

  • id (integer) -- A unique integer value identifying this certificate lifetime.

Status Codes
Response JSON Object

  • days (integer) -- The number of days the certificate is valid for.

  • updated_at (string) -- (read only)

  • updated_by (integer) -- (read only)

PATCH /pki/lifetime/{id}/
Parameters

  • id (integer) -- A unique integer value identifying this certificate lifetime.

Request JSON Object

  • days (integer) -- The number of days the certificate is valid for.

  • updated_at (string) -- (read only)

  • updated_by (integer) -- (read only)

Status Codes
Response JSON Object

  • days (integer) -- The number of days the certificate is valid for.

  • updated_at (string) -- (read only)

  • updated_by (integer) -- (read only)

GET /pki/redis/private/
Status Codes
GET /pki/redis/pub/
Status Codes
POST /pki/site/
Status Codes
GET /policies/
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[].condition_groups[].date_conditions[].age (string) --

  • results[].condition_groups[].date_conditions[].condition_group (integer) -- (required)

  • results[].condition_groups[].date_conditions[].date_field (string) --

  • results[].condition_groups[].date_conditions[].id (integer) -- (read only)

  • results[].condition_groups[].date_conditions[].include (boolean) --

  • results[].condition_groups[].date_conditions[].older_or_newer (string) --

  • results[].condition_groups[].filesize_conditions[].condition_group (integer) -- (required)

  • results[].condition_groups[].filesize_conditions[].greater_or_less (string) -- (required)

  • results[].condition_groups[].filesize_conditions[].id (integer) -- (read only)

  • results[].condition_groups[].filesize_conditions[].include (boolean) --

  • results[].condition_groups[].filesize_conditions[].size (integer) -- (required)

  • results[].condition_groups[].filetype_conditions[].condition_group (integer) -- (required)

  • results[].condition_groups[].filetype_conditions[].filetypes[] (string) --

  • results[].condition_groups[].filetype_conditions[].id (integer) -- (read only)

  • results[].condition_groups[].filetype_conditions[].include (boolean) --

  • results[].condition_groups[].id (integer) -- (read only)

  • results[].condition_groups[].name (string) -- (required)

  • results[].condition_groups[].policy (integer) -- (required)

  • results[].created (string) -- (read only)

  • results[].enabled (boolean) --

  • results[].filesystem (string) --

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

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

  • results[].order.by (string) --

  • results[].order.id (integer) -- (read only)

  • results[].order.reverse (boolean) --

  • results[].policy_type (string) --

  • results[].schedule.day_of_month (string) -- Cron Days Of The Month to Run. Use "*" for "all". (Example: "1,15")

  • results[].schedule.day_of_week (string) -- Cron Days Of The Week to Run. Use "*" for "all". (Example: "0,5")

  • results[].schedule.first_occur (boolean) -- Whether the first occurrence will be at the stipulated time.

  • results[].schedule.hour (string) -- Cron Hours to Run. Use "*" for "all". (Example: "8,20")

  • results[].schedule.id (integer) -- (read only)

  • results[].schedule.minute (string) -- Cron Minutes to Run. Use "*" for "all". (Example: "0,30")

  • results[].schedule.month_of_year (string) -- Cron Months Of The Year to Run. Use "*" for "all". (Example: "0,6")

  • results[].schedule.start_date_time (string) -- Start date time based on the time provided, timezone and if self.first_occur is true.

  • results[].schedule.time (string) -- Time to start running on the policy's SITE. REMEMBER: The Ngenea hub and the site may be running in different timezones

  • results[].schedule.timezone (string) -- (required)

  • results[].site (integer) --

  • results[].spaces[] (integer) --

  • results[].threads (integer) -- Number of threads to run policy on

  • results[].triggers (string) -- (read only)

POST /policies/
Request JSON Object

  • created (string) -- (read only)

  • enabled (boolean) --

  • filesystem (string) --

  • id (integer) -- (read only)

  • name (string) -- (required)

  • order.by (string) --

  • order.id (integer) -- (read only)

  • order.reverse (boolean) --

  • policy_type (string) --

  • schedule.day_of_month (string) -- Cron Days Of The Month to Run. Use "*" for "all". (Example: "1,15")

  • schedule.day_of_week (string) -- Cron Days Of The Week to Run. Use "*" for "all". (Example: "0,5")

  • schedule.first_occur (boolean) -- Whether the first occurrence will be at the stipulated time.

  • schedule.hour (string) -- Cron Hours to Run. Use "*" for "all". (Example: "8,20")

  • schedule.id (integer) -- (read only)

  • schedule.minute (string) -- Cron Minutes to Run. Use "*" for "all". (Example: "0,30")

  • schedule.month_of_year (string) -- Cron Months Of The Year to Run. Use "*" for "all". (Example: "0,6")

  • schedule.time (string) -- Time to start running on the policy's SITE. REMEMBER: The Ngenea hub and the site may be running in different timezones

  • site (integer) --

  • spaces[] (integer) --

  • threads (integer) -- Number of threads to run policy on

  • triggers[].is_cloud (boolean) --

  • triggers[].lower_threshold (number) --

  • triggers[].max_utilisation (number) --

  • triggers[].pool_name (string) -- (required)

  • triggers[].premigrate_threshold (number) --

  • triggers[].upper_threshold (number) --

Status Codes
Response JSON Object

  • created (string) -- (read only)

  • enabled (boolean) --

  • filesystem (string) --

  • id (integer) -- (read only)

  • name (string) -- (required)

  • order (integer) --

  • policy_type (string) --

  • schedule.day_of_month (string) -- Cron Days Of The Month to Run. Use "*" for "all". (Example: "1,15")

  • schedule.day_of_week (string) -- Cron Days Of The Week to Run. Use "*" for "all". (Example: "0,5")

  • schedule.first_occur (boolean) -- Whether the first occurrence will be at the stipulated time.

  • schedule.hour (string) -- Cron Hours to Run. Use "*" for "all". (Example: "8,20")

  • schedule.id (integer) -- (read only)

  • schedule.minute (string) -- Cron Minutes to Run. Use "*" for "all". (Example: "0,30")

  • schedule.month_of_year (string) -- Cron Months Of The Year to Run. Use "*" for "all". (Example: "0,6")

  • schedule.time (string) -- Time to start running on the policy's SITE. REMEMBER: The Ngenea hub and the site may be running in different timezones

  • site (integer) --

  • spaces[] (integer) --

  • threads (integer) -- Number of threads to run policy on

  • triggers[].id (integer) -- (read only)

  • triggers[].is_cloud (boolean) --

  • triggers[].lower_threshold (number) --

  • triggers[].max_utilisation (number) --

  • triggers[].pool_name (string) -- (required)

  • triggers[].premigrate_threshold (number) --

  • triggers[].upper_threshold (number) --

GET /policies/{id}/
Parameters

  • id (string) --

Status Codes
Response JSON Object

  • condition_groups[].date_conditions[].age (string) --

  • condition_groups[].date_conditions[].condition_group (integer) -- (required)

  • condition_groups[].date_conditions[].date_field (string) --

  • condition_groups[].date_conditions[].id (integer) -- (read only)

  • condition_groups[].date_conditions[].include (boolean) --

  • condition_groups[].date_conditions[].older_or_newer (string) --

  • condition_groups[].filesize_conditions[].condition_group (integer) -- (required)

  • condition_groups[].filesize_conditions[].greater_or_less (string) -- (required)

  • condition_groups[].filesize_conditions[].id (integer) -- (read only)

  • condition_groups[].filesize_conditions[].include (boolean) --

  • condition_groups[].filesize_conditions[].size (integer) -- (required)

  • condition_groups[].filetype_conditions[].condition_group (integer) -- (required)

  • condition_groups[].filetype_conditions[].filetypes[] (string) --

  • condition_groups[].filetype_conditions[].id (integer) -- (read only)

  • condition_groups[].filetype_conditions[].include (boolean) --

  • condition_groups[].id (integer) -- (read only)

  • condition_groups[].name (string) -- (required)

  • condition_groups[].policy (integer) -- (required)

  • created (string) -- (read only)

  • enabled (boolean) --

  • filesystem (string) --

  • id (integer) -- (read only)

  • name (string) -- (required)

  • order.by (string) --

  • order.id (integer) -- (read only)

  • order.reverse (boolean) --

  • policy_type (string) --

  • schedule.day_of_month (string) -- Cron Days Of The Month to Run. Use "*" for "all". (Example: "1,15")

  • schedule.day_of_week (string) -- Cron Days Of The Week to Run. Use "*" for "all". (Example: "0,5")

  • schedule.first_occur (boolean) -- Whether the first occurrence will be at the stipulated time.

  • schedule.hour (string) -- Cron Hours to Run. Use "*" for "all". (Example: "8,20")

  • schedule.id (integer) -- (read only)

  • schedule.minute (string) -- Cron Minutes to Run. Use "*" for "all". (Example: "0,30")

  • schedule.month_of_year (string) -- Cron Months Of The Year to Run. Use "*" for "all". (Example: "0,6")

  • schedule.start_date_time (string) -- Start date time based on the time provided, timezone and if self.first_occur is true.

  • schedule.time (string) -- Time to start running on the policy's SITE. REMEMBER: The Ngenea hub and the site may be running in different timezones

  • schedule.timezone (string) -- (required)

  • site (integer) --

  • spaces[] (integer) --

  • threads (integer) -- Number of threads to run policy on

  • triggers (string) -- (read only)

PATCH /policies/{id}/
Parameters

  • id (string) --

Request JSON Object

  • created (string) -- (read only)

  • enabled (boolean) --

  • filesystem (string) --

  • id (integer) -- (read only)

  • name (string) -- (required)

  • order.by (string) --

  • order.id (integer) -- (read only)

  • order.reverse (boolean) --

  • policy_type (string) --

  • schedule.day_of_month (string) -- Cron Days Of The Month to Run. Use "*" for "all". (Example: "1,15")

  • schedule.day_of_week (string) -- Cron Days Of The Week to Run. Use "*" for "all". (Example: "0,5")

  • schedule.first_occur (boolean) -- Whether the first occurrence will be at the stipulated time.

  • schedule.hour (string) -- Cron Hours to Run. Use "*" for "all". (Example: "8,20")

  • schedule.id (integer) -- (read only)

  • schedule.minute (string) -- Cron Minutes to Run. Use "*" for "all". (Example: "0,30")

  • schedule.month_of_year (string) -- Cron Months Of The Year to Run. Use "*" for "all". (Example: "0,6")

  • schedule.time (string) -- Time to start running on the policy's SITE. REMEMBER: The Ngenea hub and the site may be running in different timezones

  • site (integer) --

  • spaces[] (integer) --

  • threads (integer) -- Number of threads to run policy on

  • triggers[].is_cloud (boolean) --

  • triggers[].lower_threshold (number) --

  • triggers[].max_utilisation (number) --

  • triggers[].pool_name (string) -- (required)

  • triggers[].premigrate_threshold (number) --

  • triggers[].upper_threshold (number) --

Status Codes
Response JSON Object

  • created (string) -- (read only)

  • enabled (boolean) --

  • filesystem (string) --

  • id (integer) -- (read only)

  • name (string) -- (required)

  • order (integer) --

  • policy_type (string) --

  • schedule.day_of_month (string) -- Cron Days Of The Month to Run. Use "*" for "all". (Example: "1,15")

  • schedule.day_of_week (string) -- Cron Days Of The Week to Run. Use "*" for "all". (Example: "0,5")

  • schedule.first_occur (boolean) -- Whether the first occurrence will be at the stipulated time.

  • schedule.hour (string) -- Cron Hours to Run. Use "*" for "all". (Example: "8,20")

  • schedule.id (integer) -- (read only)

  • schedule.minute (string) -- Cron Minutes to Run. Use "*" for "all". (Example: "0,30")

  • schedule.month_of_year (string) -- Cron Months Of The Year to Run. Use "*" for "all". (Example: "0,6")

  • schedule.time (string) -- Time to start running on the policy's SITE. REMEMBER: The Ngenea hub and the site may be running in different timezones

  • site (integer) --

  • spaces[] (integer) --

  • threads (integer) -- Number of threads to run policy on

  • triggers[].id (integer) -- (read only)

  • triggers[].is_cloud (boolean) --

  • triggers[].lower_threshold (number) --

  • triggers[].max_utilisation (number) --

  • triggers[].pool_name (string) -- (required)

  • triggers[].premigrate_threshold (number) --

  • triggers[].upper_threshold (number) --

DELETE /policies/{id}/
Parameters

  • id (string) --

Status Codes
POST /policies/{id}/run/
Parameters

  • id (string) --

Status Codes

  • 202 Accepted -- Task id of the task fired for the associated request.

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[].space (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)

  • space (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

  • parent_lookup_schedule (string) --

  • id (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

  • parent_lookup_schedule (string) --

  • id (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

  • parent_lookup_schedule (string) --

  • id (string) --

Status Codes
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) --

PATCH /search/metadata/

API endpoint for file search

Request JSON Object

  • id (integer) -- (read only)

  • url (string) -- (read only)

Status Codes
Response JSON Object

  • id (integer) -- (read only)

  • url (string) -- (read only)

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

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

  • group_by_name (boolean) --

    When this url parameter is 'True' results are merged based on matching file name. e.g.

    [
  {
    data: [
      {site: site1, path: /mmfs1, ...},
      {site: site2, path: /mmfs1, ...}
    ]
  },
  {
    foo: [
      {site: site1, path: /mmfs1/data, ...}
      # not present on site2
    ]
  }
}

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)

  • proxies (object) -- File proxies (thumbnails, etc.)

  • site (string) -- Site Name

DELETE /search/{id}/

API endpoint for file search

Parameters

  • id (string) --

Status Codes
GET /servers/
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[].list_of_interfaces (object) -- List of interfaces of this server

  • results[].name (string) -- Server name (required)

  • results[].site (integer) -- Site correlated with this server (required)

GET /servers/{id}/
Parameters

  • id (string) --

Status Codes
Response JSON Object

  • list_of_interfaces (object) -- List of interfaces of this server

  • name (string) -- Server name (required)

  • site (integer) -- Site correlated with this server (required)

GET /settings/

API to get a list of global settings.

Status Codes
Response JSON Object

  • [].desc (string) -- (read only)

  • [].id (integer) -- (read only)

  • [].key (string) -- (required)

  • [].value (object) --

PATCH /settings/

API to set a setting or a group of global settings. A group of settings should be sent in key-value schema. Requested data will be stored in the database, and then sent to each site. Terminology Setting - An individual setting e.g. ngenea:realm

Notes on use:

  • Non-global settings cannot be set on this endpoint either alone or with global settings

  • Setting a key to None will delete it from the database and set null on all active sites

    e.g. {"values": [{"key": "ngeneahsm_targets:devaws:Storage", "value": None}]}

Request JSON Object

  • values[].desc (string) -- (read only)

  • values[].id (integer) -- (read only)

  • values[].key (string) -- (required)

  • values[].value (object) --

Status Codes

  • 202 Accepted -- Task id of the task fired for the associated request per site.

POST /settings/sync/

API to sync global settings on each site Stored data will be sent to the given site or to each site if not given.

Query Parameters

  • site (string) -- Site to run the sync operation on if provided, otherwise all sites

Status Codes

  • 202 Accepted -- Task id of the task fired for the associated request per site.

GET /settingstasks/

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[].id (integer) -- (read only)

  • results[].job (integer) --

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

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

  • results[].state (string) --

  • results[].task_id (string) -- (read only)

  • results[].tasktype (string) -- (read only)

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

GET /settingstasks/{id}/

API endpoint for viewing tasks.

Parameters

  • id (string) --

Status Codes
Response JSON Object

  • completed (string) -- Time of the task completion

  • friendly_name (string) -- Text to be used to describe what this task is doing.

  • id (integer) -- (read only)

  • job (integer) --

  • request (string) -- (read only)

  • results (string) -- (read only)

  • runtime (string) -- (read only)

  • site (string) -- (required)

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

  • state (string) --

  • task_id (string) -- (read only)

  • tasktype (string) -- (read only)

  • url (string) -- (read only)

GET /shares/nfs/
Status Codes
Response JSON Object

  • [].clients[].advanced_settings (object) --

  • [].clients[].anonymous_group_id (integer) --

  • [].clients[].anonymous_user_id (integer) --

  • [].clients[].asynchronous (boolean) --

  • [].clients[].force_all_user_id (boolean) --

  • [].clients[].force_root_user_id (boolean) --

  • [].clients[].fsid (integer) --

  • [].clients[].hosts (string) -- (required)

  • [].clients[].id (integer) -- (read only)

  • [].clients[].insecure_ports (boolean) --

  • [].clients[].nfs_share (integer) -- (required)

  • [].clients[].on_sites (object) --

  • [].clients[].read_only (boolean) --

  • [].clients[].subtree_check (boolean) --

  • [].clients[].uuid (string) -- (read only)

  • [].clients[].write_delay (boolean) --

  • [].id (integer) -- (read only)

  • [].name (string) -- Note: This name is for identification only. NFSClients don't have names in remote representations

  • [].path (string) --

  • [].space (integer) -- (required)

  • [].uuid (string) -- (read only)

POST /shares/nfs/
Request JSON Object

  • clients[].advanced_settings (object) --

  • clients[].anonymous_group_id (integer) --

  • clients[].anonymous_user_id (integer) --

  • clients[].asynchronous (boolean) --

  • clients[].force_all_user_id (boolean) --

  • clients[].force_root_user_id (boolean) --

  • clients[].fsid (integer) --

  • clients[].hosts (string) -- (required)

  • clients[].id (integer) -- (read only)

  • clients[].insecure_ports (boolean) --

  • clients[].nfs_share (integer) -- (required)

  • clients[].on_sites (object) --

  • clients[].read_only (boolean) --

  • clients[].subtree_check (boolean) --

  • clients[].uuid (string) -- (read only)

  • clients[].write_delay (boolean) --

  • id (integer) -- (read only)

  • name (string) -- Note: This name is for identification only. NFSClients don't have names in remote representations

  • path (string) --

  • space (integer) -- (required)

  • uuid (string) -- (read only)

Status Codes
Response JSON Object

  • clients[].advanced_settings (object) --

  • clients[].anonymous_group_id (integer) --

  • clients[].anonymous_user_id (integer) --

  • clients[].asynchronous (boolean) --

  • clients[].force_all_user_id (boolean) --

  • clients[].force_root_user_id (boolean) --

  • clients[].fsid (integer) --

  • clients[].hosts (string) -- (required)

  • clients[].id (integer) -- (read only)

  • clients[].insecure_ports (boolean) --

  • clients[].nfs_share (integer) -- (required)

  • clients[].on_sites (object) --

  • clients[].read_only (boolean) --

  • clients[].subtree_check (boolean) --

  • clients[].uuid (string) -- (read only)

  • clients[].write_delay (boolean) --

  • id (integer) -- (read only)

  • name (string) -- Note: This name is for identification only. NFSClients don't have names in remote representations

  • path (string) --

  • space (integer) -- (required)

  • uuid (string) -- (read only)

GET /shares/nfs/{id}/
Parameters

  • id (integer) -- A unique integer value identifying this nfs share.

Status Codes
Response JSON Object

  • clients[].advanced_settings (object) --

  • clients[].anonymous_group_id (integer) --

  • clients[].anonymous_user_id (integer) --

  • clients[].asynchronous (boolean) --

  • clients[].force_all_user_id (boolean) --

  • clients[].force_root_user_id (boolean) --

  • clients[].fsid (integer) --

  • clients[].hosts (string) -- (required)

  • clients[].id (integer) -- (read only)

  • clients[].insecure_ports (boolean) --

  • clients[].nfs_share (integer) -- (required)

  • clients[].on_sites (object) --

  • clients[].read_only (boolean) --

  • clients[].subtree_check (boolean) --

  • clients[].uuid (string) -- (read only)

  • clients[].write_delay (boolean) --

  • id (integer) -- (read only)

  • name (string) -- Note: This name is for identification only. NFSClients don't have names in remote representations

  • path (string) --

  • space (integer) -- (required)

  • uuid (string) -- (read only)

PATCH /shares/nfs/{id}/
Parameters

  • id (integer) -- A unique integer value identifying this nfs share.

Request JSON Object

  • clients[].advanced_settings (object) --

  • clients[].anonymous_group_id (integer) --

  • clients[].anonymous_user_id (integer) --

  • clients[].asynchronous (boolean) --

  • clients[].force_all_user_id (boolean) --

  • clients[].force_root_user_id (boolean) --

  • clients[].fsid (integer) --

  • clients[].hosts (string) -- (required)

  • clients[].id (integer) -- (read only)

  • clients[].insecure_ports (boolean) --

  • clients[].nfs_share (integer) -- (required)

  • clients[].on_sites (object) --

  • clients[].read_only (boolean) --

  • clients[].subtree_check (boolean) --

  • clients[].uuid (string) -- (read only)

  • clients[].write_delay (boolean) --

  • id (integer) -- (read only)

  • name (string) -- Note: This name is for identification only. NFSClients don't have names in remote representations

  • path (string) --

  • space (integer) -- (required)

  • uuid (string) -- (read only)

Status Codes
Response JSON Object

  • clients[].advanced_settings (object) --

  • clients[].anonymous_group_id (integer) --

  • clients[].anonymous_user_id (integer) --

  • clients[].asynchronous (boolean) --

  • clients[].force_all_user_id (boolean) --

  • clients[].force_root_user_id (boolean) --

  • clients[].fsid (integer) --

  • clients[].hosts (string) -- (required)

  • clients[].id (integer) -- (read only)

  • clients[].insecure_ports (boolean) --

  • clients[].nfs_share (integer) -- (required)

  • clients[].on_sites (object) --

  • clients[].read_only (boolean) --

  • clients[].subtree_check (boolean) --

  • clients[].uuid (string) -- (read only)

  • clients[].write_delay (boolean) --

  • id (integer) -- (read only)

  • name (string) -- Note: This name is for identification only. NFSClients don't have names in remote representations

  • path (string) --

  • space (integer) -- (required)

  • uuid (string) -- (read only)

DELETE /shares/nfs/{id}/
Parameters

  • id (integer) -- A unique integer value identifying this nfs share.

Status Codes
GET /shares/samba/
Status Codes
Response JSON Object

  • [].admin_users (object) --

  • [].advanced_settings (object) --

  • [].allowed_users (object) --

  • [].create_mask (string) --

  • [].directory_mask (string) --

  • [].force_create_mode (string) --

  • [].force_directory_mode (string) --

  • [].guest_ok (boolean) --

  • [].hosts_allow (object) --

  • [].hosts_deny (object) --

  • [].hsm_support (boolean) --

  • [].id (integer) -- (read only)

  • [].multi_thread_reads (boolean) --

  • [].multi_thread_writes (boolean) --

  • [].name (string) -- (required)

  • [].on_sites (object) --

  • [].path (string) --

  • [].read_only (boolean) -- (required)

  • [].root_share_locking (boolean) --

  • [].space (integer) -- (required)

  • [].uuid (string) -- (read only)

  • [].visible (boolean) -- (required)

POST /shares/samba/
Request JSON Object

  • admin_users (object) --

  • advanced_settings (object) --

  • allowed_users (object) --

  • create_mask (string) --

  • directory_mask (string) --

  • force_create_mode (string) --

  • force_directory_mode (string) --

  • guest_ok (boolean) --

  • hosts_allow (object) --

  • hosts_deny (object) --

  • hsm_support (boolean) --

  • id (integer) -- (read only)

  • multi_thread_reads (boolean) --

  • multi_thread_writes (boolean) --

  • name (string) -- (required)

  • on_sites (object) --

  • path (string) --

  • read_only (boolean) -- (required)

  • root_share_locking (boolean) --

  • space (integer) -- (required)

  • uuid (string) -- (read only)

  • visible (boolean) -- (required)

Status Codes
Response JSON Object

  • admin_users (object) --

  • advanced_settings (object) --

  • allowed_users (object) --

  • create_mask (string) --

  • directory_mask (string) --

  • force_create_mode (string) --

  • force_directory_mode (string) --

  • guest_ok (boolean) --

  • hosts_allow (object) --

  • hosts_deny (object) --

  • hsm_support (boolean) --

  • id (integer) -- (read only)

  • multi_thread_reads (boolean) --

  • multi_thread_writes (boolean) --

  • name (string) -- (required)

  • on_sites (object) --

  • path (string) --

  • read_only (boolean) -- (required)

  • root_share_locking (boolean) --

  • space (integer) -- (required)

  • uuid (string) -- (read only)

  • visible (boolean) -- (required)

GET /shares/samba/{id}/
Parameters

  • id (integer) -- A unique integer value identifying this samba share.

Status Codes
Response JSON Object

  • admin_users (object) --

  • advanced_settings (object) --

  • allowed_users (object) --

  • create_mask (string) --

  • directory_mask (string) --

  • force_create_mode (string) --

  • force_directory_mode (string) --

  • guest_ok (boolean) --

  • hosts_allow (object) --

  • hosts_deny (object) --

  • hsm_support (boolean) --

  • id (integer) -- (read only)

  • multi_thread_reads (boolean) --

  • multi_thread_writes (boolean) --

  • name (string) -- (required)

  • on_sites (object) --

  • path (string) --

  • read_only (boolean) -- (required)

  • root_share_locking (boolean) --

  • space (integer) -- (required)

  • uuid (string) -- (read only)

  • visible (boolean) -- (required)

PATCH /shares/samba/{id}/
Parameters

  • id (integer) -- A unique integer value identifying this samba share.

Request JSON Object

  • admin_users (object) --

  • advanced_settings (object) --

  • allowed_users (object) --

  • create_mask (string) --

  • directory_mask (string) --

  • force_create_mode (string) --

  • force_directory_mode (string) --

  • guest_ok (boolean) --

  • hosts_allow (object) --

  • hosts_deny (object) --

  • hsm_support (boolean) --

  • id (integer) -- (read only)

  • multi_thread_reads (boolean) --

  • multi_thread_writes (boolean) --

  • name (string) -- (required)

  • on_sites (object) --

  • path (string) --

  • read_only (boolean) -- (required)

  • root_share_locking (boolean) --

  • space (integer) -- (required)

  • uuid (string) -- (read only)

  • visible (boolean) -- (required)

Status Codes
Response JSON Object

  • admin_users (object) --

  • advanced_settings (object) --

  • allowed_users (object) --

  • create_mask (string) --

  • directory_mask (string) --

  • force_create_mode (string) --

  • force_directory_mode (string) --

  • guest_ok (boolean) --

  • hosts_allow (object) --

  • hosts_deny (object) --

  • hsm_support (boolean) --

  • id (integer) -- (read only)

  • multi_thread_reads (boolean) --

  • multi_thread_writes (boolean) --

  • name (string) -- (required)

  • on_sites (object) --

  • path (string) --

  • read_only (boolean) -- (required)

  • root_share_locking (boolean) --

  • space (integer) -- (required)

  • uuid (string) -- (read only)

  • visible (boolean) -- (required)

DELETE /shares/samba/{id}/
Parameters

  • id (integer) -- A unique integer value identifying this samba share.

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[].am_i_configured (boolean) -- Boolean field determining if UI has been configured for the site

  • results[].bandwidth (integer) -- speed for site (in Mb/s)

  • results[].color[] (integer) --

  • results[].directories_count (integer) -- How many directories this site has

  • results[].editable (string) -- (read only)

  • results[].files_count (integer) -- How many files this site has

  • results[].files_hydrated_count (integer) -- How many files hydrated this site has

  • results[].files_stubbed_count (integer) -- How many files stubbed this site has

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

  • results[].label (string) -- Human readable name for this site

  • results[].name (string) -- Site Name. Must match [a-zA-Z0-9-_]+ (required)

  • results[].public_url (string) -- The base URL by which this site can be reached

  • results[].shortcode (string) -- Shortcode

  • results[].spaces[] (string) --

  • results[].type (string) -- Type indicating where the site (pixstor) is deployed

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

POST /sites/

API endpoint for managing sites.

Request JSON Object

  • am_i_configured (boolean) -- Boolean field determining if UI has been configured for the site

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

  • color[] (integer) --

  • directories_count (integer) -- How many directories this site has

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

  • enable_auto_file_batch_sizing (boolean) -- If optimal batch size should be determined at runtime.

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

  • file_batch_gb (integer) -- File batch GB

  • file_batch_size (integer) -- File batch size

  • files_count (integer) -- How many files this site has

  • files_hydrated_count (integer) -- How many files hydrated this site has

  • files_stubbed_count (integer) -- How many files stubbed this site has

  • 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

  • label (string) -- Human readable name for this site

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

  • name (string) -- Site Name. Must match [a-zA-Z0-9-_]+ (required)

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

  • public_url (string) -- The base URL by which this site can be reached

  • shortcode (string) -- Shortcode (required)

  • spaces[] (string) --

  • type (string) -- Type indicating where the site (pixstor) is deployed

Status Codes
Response JSON Object

  • am_i_configured (boolean) -- Boolean field determining if UI has been configured for the site

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

  • color[] (integer) --

  • directories_count (integer) -- How many directories this site has

  • editable (string) -- (read only)

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

  • enable_auto_file_batch_sizing (boolean) -- If optimal batch size should be determined at runtime.

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

  • file_batch_gb (integer) -- File batch GB

  • file_batch_size (integer) -- File batch size

  • files_count (integer) -- How many files this site has

  • files_hydrated_count (integer) -- How many files hydrated this site has

  • files_stubbed_count (integer) -- How many files stubbed this site has

  • 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

  • label (string) -- Human readable name for this site

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

  • name (string) -- Site Name. Must match [a-zA-Z0-9-_]+ (required)

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

  • public_url (string) -- The base URL by which this site can be reached

  • shortcode (string) -- Shortcode

  • spaces[].id (integer) -- (read only)

  • spaces[].name (string) -- Space Name (required)

  • spaces[].url (string) -- (read only)

  • type (string) -- Type indicating where the site (pixstor) is deployed

  • url (string) -- (read only)

GET /sites/{id}/

API endpoint for managing sites.

Parameters

  • id (string) --

Status Codes
Response JSON Object

  • am_i_configured (boolean) -- Boolean field determining if UI has been configured for the site

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

  • color[] (integer) --

  • directories_count (integer) -- How many directories this site has

  • editable (string) -- (read only)

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

  • enable_auto_file_batch_sizing (boolean) -- If optimal batch size should be determined at runtime.

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

  • file_batch_gb (integer) -- File batch GB

  • file_batch_size (integer) -- File batch size

  • files_count (integer) -- How many files this site has

  • files_hydrated_count (integer) -- How many files hydrated this site has

  • files_stubbed_count (integer) -- How many files stubbed this site has

  • 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

  • label (string) -- Human readable name for this site

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

  • name (string) -- Site Name. Must match [a-zA-Z0-9-_]+ (required)

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

  • public_url (string) -- The base URL by which this site can be reached

  • shortcode (string) -- Shortcode

  • spaces[].id (integer) -- (read only)

  • spaces[].name (string) -- Space Name (required)

  • spaces[].url (string) -- (read only)

  • type (string) -- Type indicating where the site (pixstor) is deployed

  • url (string) -- (read only)

PATCH /sites/{id}/

API endpoint for managing sites.

Parameters

  • id (string) --

Request JSON Object

  • am_i_configured (boolean) -- Boolean field determining if UI has been configured for the site

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

  • color[] (integer) --

  • directories_count (integer) -- How many directories this site has

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

  • enable_auto_file_batch_sizing (boolean) -- If optimal batch size should be determined at runtime.

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

  • file_batch_gb (integer) -- File batch GB

  • file_batch_size (integer) -- File batch size

  • files_count (integer) -- How many files this site has

  • files_hydrated_count (integer) -- How many files hydrated this site has

  • files_stubbed_count (integer) -- How many files stubbed this site has

  • 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

  • label (string) -- Human readable name for this site

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

  • name (string) -- Site Name. Must match [a-zA-Z0-9-_]+

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

  • public_url (string) -- The base URL by which this site can be reached

  • shortcode (string) -- Shortcode

  • spaces[] (string) --

  • type (string) -- Type indicating where the site (pixstor) is deployed

Status Codes
Response JSON Object

  • am_i_configured (boolean) -- Boolean field determining if UI has been configured for the site

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

  • color[] (integer) --

  • directories_count (integer) -- How many directories this site has

  • editable (string) -- (read only)

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

  • enable_auto_file_batch_sizing (boolean) -- If optimal batch size should be determined at runtime.

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

  • file_batch_gb (integer) -- File batch GB

  • file_batch_size (integer) -- File batch size

  • files_count (integer) -- How many files this site has

  • files_hydrated_count (integer) -- How many files hydrated this site has

  • files_stubbed_count (integer) -- How many files stubbed this site has

  • 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

  • label (string) -- Human readable name for this site

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

  • name (string) -- Site Name. Must match [a-zA-Z0-9-_]+ (required)

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

  • public_url (string) -- The base URL by which this site can be reached

  • shortcode (string) -- Shortcode

  • spaces[].id (integer) -- (read only)

  • spaces[].name (string) -- Space Name (required)

  • spaces[].url (string) -- (read only)

  • type (string) -- Type indicating where the site (pixstor) is deployed

  • 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

  • am_i_configured (boolean) -- Boolean field determining if UI has been configured for the site

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

  • color[] (integer) --

  • directories_count (integer) -- How many directories this site has

  • editable (string) -- (read only)

  • files_count (integer) -- How many files this site has

  • files_hydrated_count (integer) -- How many files hydrated this site has

  • files_stubbed_count (integer) -- How many files stubbed this site has

  • id (integer) -- (read only)

  • label (string) -- Human readable name for this site

  • name (string) -- Site Name. Must match [a-zA-Z0-9-_]+ (required)

  • public_url (string) -- The base URL by which this site can be reached

  • shortcode (string) -- Shortcode

  • spaces[] (string) --

  • type (string) -- Type indicating where the site (pixstor) is deployed

  • url (string) -- (read only)

POST /sites/{id}/refresh/

API endpoint for managing sites.

Parameters

  • id (string) --

Status Codes
Response JSON Object

  • am_i_configured (boolean) -- Boolean field determining if UI has been configured for the site

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

  • color[] (integer) --

  • directories_count (integer) -- How many directories this site has

  • editable (string) -- (read only)

  • files_count (integer) -- How many files this site has

  • files_hydrated_count (integer) -- How many files hydrated this site has

  • files_stubbed_count (integer) -- How many files stubbed this site has

  • id (integer) -- (read only)

  • label (string) -- Human readable name for this site

  • name (string) -- Site Name. Must match [a-zA-Z0-9-_]+ (required)

  • public_url (string) -- The base URL by which this site can be reached

  • shortcode (string) -- Shortcode

  • spaces[] (string) --

  • type (string) -- Type indicating where the site (pixstor) is deployed

  • url (string) -- (read only)

GET /sites/{id}/settings/

API endpoint for managing sites.

Parameters

  • id (string) --

Query Parameters

  • flat (boolean) -- Return flat dict

Status Codes
Response JSON Object

  • [].desc (string) -- (read only)

  • [].id (integer) -- (read only)

  • [].key (string) -- (required)

  • [].value (object) --

PATCH /sites/{id}/settings/

API to set a setting or a group of settings associated with a site. A group of settings should be sent in key-value schema. Terminology Setting - An individual setting e.g. sambda:realm

Parameters

  • id (string) --

Request JSON Object

  • values[].desc (string) -- (read only)

  • values[].id (integer) -- (read only)

  • values[].key (string) -- (required)

  • values[].value (object) --

Status Codes

  • 202 Accepted -- Task id of the task fired for the associated request.

POST /sites/{id}/settings/refresh/

Refresh settings for a given site under management. This API will also create settings in the hub for this site if they don't already exist.

Parameters

  • id (string) --

Status Codes

  • 202 Accepted -- Task id of the task fired for the associated request.

GET /spaces/

Model View Set for filebrowser's Space model.

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[].color[] (integer) --

  • results[].created (string) -- Time of the job creation (read only)

  • results[].editable (string) -- (read only)

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

  • results[].immutable (boolean) -- Space that once created cannot be deleted or updated. Usually the default space.

  • results[].mountpoint (string) -- Mount point (required)

  • results[].name (string) -- Space Name (required)

  • results[].on_sites (object) --

  • results[].relationships (string) -- (read only)

  • results[].sites[].id (string) -- (read only)

  • results[].sites[].label (string) -- (required)

  • results[].sites[].name (string) -- (required)

  • results[].sites[].pool (string) -- (read only)

  • results[].sites[].usage[] (integer) --

  • results[].size (integer) -- Space size quota in bytes. No value specified, means as large as your system allows.

  • results[].snapshot_schedule.duration (string) -- (required)

  • results[].snapshot_schedule.frequency (string) -- (required)

  • results[].snapshot_schedule.id (integer) -- (read only)

  • results[].snapshot_schedule.space (integer) --

  • results[].snapshot_schedule.time (string) -- (required)

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

  • results[].uuid (string) -- (read only)

POST /spaces/

Model View Set for filebrowser's Space model.

Request JSON Object

  • color[] (integer) --

  • created (string) -- Time of the job creation (read only)

  • mountpoint (string) -- (required)

  • name (string) -- (required)

  • sites[].id (string) -- (read only)

  • sites[].label (string) -- (required)

  • sites[].name (string) -- (required)

  • sites[].pool (string) -- (read only)

  • sites[].usage[] (integer) --

  • size (integer) -- Space size quota in bytes. No value specified, means as large as your system allows.

  • snapshot_schedule.duration (string) -- (required)

  • snapshot_schedule.frequency (string) -- (required)

  • snapshot_schedule.id (integer) -- (read only)

  • snapshot_schedule.space (integer) --

  • snapshot_schedule.time (string) -- (required)

Status Codes
Response JSON Object

  • color[] (integer) --

  • created (string) -- Time of the job creation (read only)

  • editable (string) -- (read only)

  • id (integer) -- (read only)

  • immutable (boolean) -- Space that once created cannot be deleted or updated. Usually the default space.

  • mountpoint (string) -- Mount point (required)

  • name (string) -- Space Name (required)

  • on_sites (object) --

  • relationships (string) -- (read only)

  • sites[].id (string) -- (read only)

  • sites[].label (string) -- (required)

  • sites[].name (string) -- (required)

  • sites[].pool (string) -- (read only)

  • sites[].usage[] (integer) --

  • size (integer) -- Space size quota in bytes. No value specified, means as large as your system allows.

  • snapshot_schedule.duration (string) -- (required)

  • snapshot_schedule.frequency (string) -- (required)

  • snapshot_schedule.id (integer) -- (read only)

  • snapshot_schedule.space (integer) --

  • snapshot_schedule.time (string) -- (required)

  • url (string) -- (read only)

  • uuid (string) -- (read only)

GET /spaces/{id}/

Model View Set for filebrowser's Space model.

Parameters

  • id (string) --

Status Codes
Response JSON Object

  • color[] (integer) --

  • created (string) -- Time of the job creation (read only)

  • editable (string) -- (read only)

  • id (integer) -- (read only)

  • immutable (boolean) -- Space that once created cannot be deleted or updated. Usually the default space.

  • mountpoint (string) -- Mount point (required)

  • name (string) -- Space Name (required)

  • on_sites (object) --

  • relationships (string) -- (read only)

  • sites[].id (string) -- (read only)

  • sites[].label (string) -- (required)

  • sites[].name (string) -- (required)

  • sites[].pool (string) -- (read only)

  • sites[].usage[] (integer) --

  • size (integer) -- Space size quota in bytes. No value specified, means as large as your system allows.

  • snapshot_schedule.duration (string) -- (required)

  • snapshot_schedule.frequency (string) -- (required)

  • snapshot_schedule.id (integer) -- (read only)

  • snapshot_schedule.space (integer) --

  • snapshot_schedule.time (string) -- (required)

  • url (string) -- (read only)

  • uuid (string) -- (read only)

PATCH /spaces/{id}/

Model View Set for filebrowser's Space model.

Parameters

  • id (string) --

Request JSON Object

  • color[] (integer) --

  • created (string) -- Time of the job creation (read only)

  • mountpoint (string) -- (read only)

  • name (string) --

  • sites[].id (string) -- (read only)

  • sites[].label (string) -- (required)

  • sites[].name (string) -- (required)

  • sites[].pool (string) -- (read only)

  • sites[].usage[] (integer) --

  • size (integer) -- Space size quota in bytes. No value specified, means as large as your system allows.

  • snapshot_schedule.duration (string) -- (required)

  • snapshot_schedule.frequency (string) -- (required)

  • snapshot_schedule.id (integer) -- (read only)

  • snapshot_schedule.space (integer) --

  • snapshot_schedule.time (string) -- (required)

Status Codes
Response JSON Object

  • color[] (integer) --

  • created (string) -- Time of the job creation (read only)

  • editable (string) -- (read only)

  • id (integer) -- (read only)

  • immutable (boolean) -- Space that once created cannot be deleted or updated. Usually the default space.

  • mountpoint (string) -- Mount point (required)

  • name (string) -- Space Name (required)

  • on_sites (object) --

  • relationships (string) -- (read only)

  • sites[].id (string) -- (read only)

  • sites[].label (string) -- (required)

  • sites[].name (string) -- (required)

  • sites[].pool (string) -- (read only)

  • sites[].usage[] (integer) --

  • size (integer) -- Space size quota in bytes. No value specified, means as large as your system allows.

  • snapshot_schedule.duration (string) -- (required)

  • snapshot_schedule.frequency (string) -- (required)

  • snapshot_schedule.id (integer) -- (read only)

  • snapshot_schedule.space (integer) --

  • snapshot_schedule.time (string) -- (required)

  • url (string) -- (read only)

  • uuid (string) -- (read only)

DELETE /spaces/{id}/

Model View Set for filebrowser's Space model.

Parameters

  • id (string) --

Status Codes
GET /spaces/{id}/files/

Model View Set for filebrowser's Space model.

Parameters

  • id (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.

  • site (string) -- Site to run the stat operation on if provided, otherwise all space's sites

  • path (string) -- Path to retrieve stat

  • details (boolean) -- Retrieve all the details of the children files

  • restricted (boolean) -- Include restricted objects

  • check_available_sites (boolean) -- Check only available sites

  • custom_refresh_period (integer) -- Custom time in seconds to invalidate the DB cache

  • custom_timeout (integer) -- Custom time in seconds to invalidate the task

  • raise_exception (boolean) -- Raise exception if timeout

Status Codes
Response JSON Object

  • atime (string) --

  • children (string) -- (read only)

  • ctime (string) --

  • data_size (integer) --

  • deleted (boolean) --

  • disk_usage (integer) --

  • image_preview (string) -- Relative URL of an image preview

  • metadata (object) --

  • mtime (string) --

  • name (string) -- Name of of the fs object

  • path (string) -- Path of the object (required)

  • path_depth (integer) --

  • remote_locations (object) --

  • restricted (boolean) --

  • site (string) -- (read only)

  • size (integer) --

  • status (string) -- Migration status

  • thumbnail (string) -- Relative URL of an object thumbnail

  • time_refreshed (string) --

  • total_files (integer) -- Only applies to directories

  • type (string) --

  • url (string) -- (read only)

  • video_preview (string) -- Relative URL of a video preview

GET /storagepools/
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[].capacity (integer) -- Capacity of storage pool (required)

  • results[].filesystem (string) -- Storage pool filesystem (required)

  • results[].free_space (integer) -- Free space of storage pool (required)

  • results[].name (string) -- Name storage pool (required)

  • results[].site (integer) -- Site correlated with storage object (required)

  • results[].used_space (integer) -- Used space of storage pool (required)

GET /storagepools/{id}/
Parameters

  • id (string) --

Status Codes
Response JSON Object

  • capacity (integer) -- Capacity of storage pool (required)

  • filesystem (string) -- Storage pool filesystem (required)

  • free_space (integer) -- Free space of storage pool (required)

  • name (string) -- Name storage pool (required)

  • site (integer) -- Site correlated with storage object (required)

  • used_space (integer) -- Used space of storage pool (required)

GET /tags/

API endpoint for search tags

Query Parameters

  • filter (string) -- substring that returned tags must contain

Status Codes
Response JSON Object

  • [].name (string) -- (required)

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

  • task_id (string) -- Task Id

  • state (array) -- Task states

  • job_id (integer) -- Job ID

  • internal (string) --

Status Codes
Response JSON Object

  • count (integer) -- (required)

  • next (string) --

  • previous (string) --

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

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

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

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

  • results[].state (string) --

  • results[].task_id (string) -- Celery task ID

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

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

GET /tasks/{id}/

API endpoint for viewing tasks.

Parameters

  • id (string) --

Status Codes
Response JSON Object

  • completed (string) -- Time of the task completion

  • friendly_name (string) -- Text to be used to describe what this task is doing.

  • id (integer) -- (read only)

  • job (integer) -- (required)

  • paths (string) -- (read only)

  • result (object) --

  • runtime (string) -- (read only)

  • site (string) -- (required)

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

  • state (string) --

  • task_id (string) -- Celery task ID

  • tasktype (string) -- (required)

  • url (string) -- (read only)

GET /tasks/{id}/files/

API endpoint for viewing tasks.

Parameters

  • id (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.

  • state (string) --

  • type (string) --

  • site (string) --

Status Codes
Response JSON Object

  • completed (string) -- Time of the task completion

  • friendly_name (string) -- Text to be used to describe what this task is doing.

  • id (integer) -- (read only)

  • job (integer) -- (required)

  • paths (string) -- (read only)

  • result (object) --

  • runtime (string) -- (read only)

  • site (string) -- (required)

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

  • state (string) --

  • task_id (string) -- Celery task ID

  • 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[].nas_user.allow_ssh (boolean) --

  • results[].nas_user.primary_group (string) -- (required)

  • results[].nas_user.uid (integer) -- UID number for the user. This is automatically generated. And cannot be changed (read only)

  • results[].profile.country (string) -- User's country

  • results[].profile.default_site (integer) --

  • results[].profile.department (string) -- Name of the department user is working in

  • results[].profile.home_site (integer) --

  • results[].profile.line_manager (string) -- Name of the line manager of the user

  • results[].profile.phone (string) -- User's phone number

  • results[].profile.timezone (string) -- Timezone in a string format e.g. 'Europe/London'

  • 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) --

  • nas_user.allow_ssh (boolean) --

  • nas_user.primary_group (string) -- (required)

  • password (string) -- (required)

  • profile.country (string) -- User's country

  • profile.default_site (integer) --

  • profile.department (string) -- Name of the department user is working in

  • profile.home_site (integer) --

  • profile.line_manager (string) -- Name of the line manager of the user

  • profile.phone (string) -- User's phone number

  • profile.timezone (string) -- Timezone in a string format e.g. 'Europe/London'

  • 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) --

  • nas_user.allow_ssh (boolean) --

  • nas_user.primary_group (string) -- (required)

  • password (string) -- (required)

  • profile.country (string) -- User's country

  • profile.default_site (integer) --

  • profile.department (string) -- Name of the department user is working in

  • profile.home_site (integer) --

  • profile.line_manager (string) -- Name of the line manager of the user

  • profile.phone (string) -- User's phone number

  • profile.timezone (string) -- Timezone in a string format e.g. 'Europe/London'

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

POST /users/change_password/

API endpoint for managing users.

Request JSON Object

  • new_password (string) -- (required)

  • old_password (string) -- (required)

Status Codes
Response JSON Object

  • new_password (string) -- (required)

  • old_password (string) -- (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) --

  • nas_user.allow_ssh (boolean) --

  • nas_user.primary_group (string) -- (required)

  • nas_user.uid (integer) -- UID number for the user. This is automatically generated. And cannot be changed (read only)

  • profile.country (string) -- User's country

  • profile.default_site (integer) --

  • profile.department (string) -- Name of the department user is working in

  • profile.home_site (integer) --

  • profile.line_manager (string) -- Name of the line manager of the user

  • profile.phone (string) -- User's phone number

  • profile.timezone (string) -- Timezone in a string format e.g. 'Europe/London'

  • 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) --

  • nas_user.allow_ssh (boolean) --

  • nas_user.primary_group (string) -- (required)

  • password (string) --

  • profile.country (string) -- User's country

  • profile.default_site (integer) --

  • profile.department (string) -- Name of the department user is working in

  • profile.home_site (integer) --

  • profile.line_manager (string) -- Name of the line manager of the user

  • profile.phone (string) -- User's phone number

  • profile.timezone (string) -- Timezone in a string format e.g. 'Europe/London'

Status Codes
Response JSON Object

  • email (string) --

  • first_name (string) --

  • groups[] (string) --

  • last_name (string) --

  • nas_user.allow_ssh (boolean) --

  • nas_user.primary_group (string) -- (required)

  • password (string) --

  • profile.country (string) -- User's country

  • profile.default_site (integer) --

  • profile.department (string) -- Name of the department user is working in

  • profile.home_site (integer) --

  • profile.line_manager (string) -- Name of the line manager of the user

  • profile.phone (string) -- User's phone number

  • profile.timezone (string) -- Timezone in a string format e.g. 'Europe/London'

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[].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

  • 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

  • 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

  • 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

  • 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

  • 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