Testbed REST API Reference#

Note

See the Glossary for the meaning of the acronyms used in this guide.

This page documents the endpoints and available HTTP methods for the Dioptra REST API. In addition to using this page, it is highly recommended that Testbed users also use the Swagger documentation that the REST API service automatically generates at runtime, which presents all of this page’s information in an interactive format. To access the Swagger documentation, just navigate to the web URL for the Testbed REST API service (omit the /api/v1 part at the end of the web address).

Authentication#

User authentication operations.

Endpoints#

The following is the list of endpoints under the /api/v1/auth/ namespace.

POST /api/v1/auth/login#

Login to a registered user account

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/auth/logout#

Logout the current user

Must be logged in.

Query Parameters

  • everywhere (boolean) – Logout on all devices.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

Artifacts#

Artifact management operations.

Endpoints#

The following is the list of endpoints under the /api/v1/artifacts/ namespace.

GET /api/v1/artifacts/#

Gets a list of all Artifact resources

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/artifacts/#

Creates an Artifact resource

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/artifacts/{id}#

Gets an Artifact resource

Parameters

  • id (integer) – ID for the Artifact resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/artifacts/{id}#

Modifies an Artifact resource

Parameters

  • id (integer) – ID for the Artifact resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/artifacts/{id}/snapshots#

Gets the Snapshots for the resource

Parameters

  • id (integer) – ID for the artifact resource.

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/artifacts/{id}/snapshots/{snapshotId}#

Gets a Snapshot for the resource by snapshot id

Parameters

  • snapshotId (integer) – Snapshot ID for the artifact resource.

  • id (integer) – ID for the artifact resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

Entrypoints#

Entrypoint management operations.

Endpoints#

The following is the list of endpoints under the /api/v1/entrypoints/ namespace.

GET /api/v1/entrypoints/#

Gets a list of Entrypoint resources matching the filter parameters

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/entrypoints/#

Creates an Entrypoint resource

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/entrypoints/drafts/#

Gets the Drafts for the resource

Query Parameters

  • draftType (string) – The type of drafts to return: all, existing, or new.

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/entrypoints/drafts/#

Creates a Draft for the resource

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/entrypoints/drafts/{draftId}#

Gets a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the entry_point resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/entrypoints/drafts/{draftId}#

Modifies a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the entry_point resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/entrypoints/drafts/{draftId}#

Deletes a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the entry_point resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/entrypoints/{id}#

Gets an Entrypoint resource by its unique ID

Parameters

  • id (integer) – ID for the Entrypoint resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/entrypoints/{id}#

Modifies an Entrypoint resource by its unique ID

Parameters

  • id (integer) – ID for the Entrypoint resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/entrypoints/{id}#

Deletes an Entrypoint resource by its unique ID

Parameters

  • id (integer) – ID for the Entrypoint resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/entrypoints/{id}/draft#

Gets the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/entrypoints/{id}/draft#

Modifies the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/entrypoints/{id}/draft#

Creates a Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/entrypoints/{id}/draft#

Deletes the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/entrypoints/{id}/plugins#

Retrieves the plugin snapshots for an entrypoint resource

Parameters

  • id (integer) – ID for the Entrypoint resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/entrypoints/{id}/plugins#

Appends plugins to an entrypoint resource

Parameters

  • id (integer) – ID for the Entrypoint resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/entrypoints/{id}/plugins/{pluginId}#

Retrieves a plugin snapshot for an entrypoint resource

Parameters

  • pluginId (integer) – ID for the Plugin resource.

  • id (integer) – ID for the Entrypoint resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/entrypoints/{id}/plugins/{pluginId}#

Removes a plugin from an entrypoint by ID

Parameters

  • pluginId (integer) – ID for the Plugin resource.

  • id (integer) – ID for the Entrypoint resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/entrypoints/{id}/queues#

Gets the list of Queues for the resource

Parameters

  • id (integer) – ID for the Entrypoint resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/entrypoints/{id}/queues#

Replaces one or more Queues to the resource

Parameters

  • id (integer) – ID for the Entrypoint resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/entrypoints/{id}/queues#

Appends one or more Queues to the resource

Parameters

  • id (integer) – ID for the Entrypoint resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/entrypoints/{id}/queues#

Removes all Queues from the resource

Parameters

  • id (integer) – ID for the Entrypoint resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/entrypoints/{id}/queues/{queueId}#

Removes a Queue from the Entrypoint resource

Parameters

  • queueId (integer) – ID for the Queue resource.

  • id (integer) – ID for the Entrypoint resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/entrypoints/{id}/snapshots#

Gets the Snapshots for the resource

Parameters

  • id (integer) – ID for the entry_point resource.

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/entrypoints/{id}/snapshots/{snapshotId}#

Gets a Snapshot for the resource by snapshot id

Parameters

  • snapshotId (integer) – Snapshot ID for the entry_point resource.

  • id (integer) – ID for the entry_point resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/entrypoints/{id}/tags#

Gets the list of Tags for the resource

Parameters

  • id (integer) – ID for the entry_point.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/entrypoints/{id}/tags#

Replaces one or more Tags to the resource

Parameters

  • id (integer) – ID for the entry_point.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/entrypoints/{id}/tags#

Appends one or more Tags to the resource

Parameters

  • id (integer) – ID for the entry_point.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/entrypoints/{id}/tags#

Removes all Tags from the resource

Parameters

  • id (integer) – ID for the entry_point.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/entrypoints/{id}/tags/{tagId}#

Removes a Tag from the resource

Parameters

  • tagId (integer) – ID for the Tag.

  • id (integer) – ID for the entry_point.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

Experiments#

Experiment management operations.

Endpoints#

The following is the list of endpoints under the /api/v1/experiments/ namespace.

GET /api/v1/experiments/#

Gets a page of Experiment resources matching the filter parameters

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/experiments/#

Creates an Experiment resource with a provided name

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/experiments/drafts/#

Gets the Drafts for the resource

Query Parameters

  • draftType (string) – The type of drafts to return: all, existing, or new.

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/experiments/drafts/#

Creates a Draft for the resource

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/experiments/drafts/{draftId}#

Gets a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/experiments/drafts/{draftId}#

Modifies a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/experiments/drafts/{draftId}#

Deletes a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/experiments/{id}#

Gets an experiment by its unique identifier

Parameters

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/experiments/{id}#

Modifies an experiment by its unique identifier

Parameters

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/experiments/{id}#

Deletes an experiment by its unique identifier

Parameters

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/experiments/{id}/draft#

Gets the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/experiments/{id}/draft#

Modifies the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/experiments/{id}/draft#

Creates a Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/experiments/{id}/draft#

Deletes the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/experiments/{id}/entrypoints#

Gets the list of Entrypoints for the resource

Parameters

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/experiments/{id}/entrypoints#

Replaces one or more Entrypoints to the resource

Parameters

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/experiments/{id}/entrypoints#

Appends one or more Entrypoints to the resource

Parameters

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/experiments/{id}/entrypoints#

Removes all Entrypoints from the resource

Parameters

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/experiments/{id}/entrypoints/{entrypointId}#

Removes a Entrypoint from the Experiment resource

Parameters

  • entrypointId (integer) – ID for the Entrypoint resource.

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/experiments/{id}/jobs#

Returns a list of jobs for a specified Experiment

Parameters

  • id (integer) – ID for the Experiment resource.

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/experiments/{id}/jobs#

Creates a Job resource under the specified Experiment

Parameters

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/experiments/{id}/jobs/{jobId}#

Gets a Job resource

Parameters

  • jobId (integer) – ID for the Job resource.

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/experiments/{id}/jobs/{jobId}#

Deletes a Job resource

Parameters

  • jobId (integer) – ID for the Job resource.

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/experiments/{id}/jobs/{jobId}/artifacts#

Creates an Artifact resource

Parameters

  • jobId (integer) – ID for the Job resource.

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/experiments/{id}/jobs/{jobId}/mlflowRun#

Gets a Job resource’s mlflow run id

Parameters

  • jobId (integer) – ID for the Job resource.

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/experiments/{id}/jobs/{jobId}/mlflowRun#

Sets the mlflow run id for a Job

Parameters

  • jobId (integer) – ID for the Job resource.

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/experiments/{id}/jobs/{jobId}/status#

Gets a Job resource’s status

Parameters

  • jobId (integer) – ID for the Job resource.

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/experiments/{id}/jobs/{jobId}/status#

Modifies a Job resource’s status

Parameters

  • jobId (integer) – ID for the Job resource.

  • id (integer) – ID for the Experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/experiments/{id}/snapshots#

Gets the Snapshots for the resource

Parameters

  • id (integer) – ID for the experiment resource.

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/experiments/{id}/snapshots/{snapshotId}#

Gets a Snapshot for the resource by snapshot id

Parameters

  • snapshotId (integer) – Snapshot ID for the experiment resource.

  • id (integer) – ID for the experiment resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/experiments/{id}/tags#

Gets the list of Tags for the resource

Parameters

  • id (integer) – ID for the experiment.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/experiments/{id}/tags#

Replaces one or more Tags to the resource

Parameters

  • id (integer) – ID for the experiment.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/experiments/{id}/tags#

Appends one or more Tags to the resource

Parameters

  • id (integer) – ID for the experiment.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/experiments/{id}/tags#

Removes all Tags from the resource

Parameters

  • id (integer) – ID for the experiment.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/experiments/{id}/tags/{tagId}#

Removes a Tag from the resource

Parameters

  • tagId (integer) – ID for the Tag.

  • id (integer) – ID for the experiment.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

Groups#

Group management operations.

Endpoints#

The following is the list of endpoints under the /api/v1/groups/ namespace.

GET /api/v1/groups/#

Gets a list of all Group resources

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/groups/{id}#

Gets a Group resource

Parameters

  • id (integer) – ID for the Group resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

Jobs#

Job management operations.

Endpoints#

The following is the list of endpoints under the /api/v1/jobs/ namespace.

GET /api/v1/jobs/#

Gets a list of all Job resources

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/jobs/{id}#

Gets a Job resource

Parameters

  • id (integer) – ID for the Job resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/jobs/{id}#

Deletes a Job resource

Parameters

  • id (integer) – ID for the Job resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/jobs/{id}/mlflowRun#

Gets a Job resource’s mlflow run id

Parameters

  • id (integer) – ID for the Job resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/jobs/{id}/mlflowRun#

Sets the mlflow run id for a Job

Parameters

  • id (integer) – ID for the Job resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/jobs/{id}/snapshots#

Gets the Snapshots for the resource

Parameters

  • id (integer) – ID for the job resource.

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/jobs/{id}/snapshots/{snapshotId}#

Gets a Snapshot for the resource by snapshot id

Parameters

  • snapshotId (integer) – Snapshot ID for the job resource.

  • id (integer) – ID for the job resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/jobs/{id}/status#

Gets a Job resource’s status

Parameters

  • id (integer) – ID for the Job resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/jobs/{id}/tags#

Gets the list of Tags for the resource

Parameters

  • id (integer) – ID for the job.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/jobs/{id}/tags#

Replaces one or more Tags to the resource

Parameters

  • id (integer) – ID for the job.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/jobs/{id}/tags#

Appends one or more Tags to the resource

Parameters

  • id (integer) – ID for the job.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/jobs/{id}/tags#

Removes all Tags from the resource

Parameters

  • id (integer) – ID for the job.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/jobs/{id}/tags/{tagId}#

Removes a Tag from the resource

Parameters

  • tagId (integer) – ID for the Tag.

  • id (integer) – ID for the job.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

Models#

Model management operations.

Endpoints#

The following is the list of endpoints under the /api/v1/models/ namespace.

GET /api/v1/models/#

Gets a list of all Model resources

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/models/#

Creates a Model resource

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/models/drafts/#

Gets the Drafts for the resource

Query Parameters

  • draftType (string) – The type of drafts to return: all, existing, or new.

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/models/drafts/#

Creates a Draft for the resource

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/models/drafts/{draftId}#

Gets a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the ml_model resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/models/drafts/{draftId}#

Modifies a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the ml_model resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/models/drafts/{draftId}#

Deletes a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the ml_model resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/models/{id}#

Gets a Model resource

Parameters

  • id (integer) – ID for the Model resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/models/{id}#

Modifies a Model resource

Parameters

  • id (integer) – ID for the Model resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/models/{id}#

Deletes a Model resource

Parameters

  • id (integer) – ID for the Model resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/models/{id}/draft#

Gets the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/models/{id}/draft#

Modifies the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/models/{id}/draft#

Creates a Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/models/{id}/draft#

Deletes the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/models/{id}/snapshots#

Gets the Snapshots for the resource

Parameters

  • id (integer) – ID for the ml_model resource.

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/models/{id}/snapshots/{snapshotId}#

Gets a Snapshot for the resource by snapshot id

Parameters

  • snapshotId (integer) – Snapshot ID for the ml_model resource.

  • id (integer) – ID for the ml_model resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/models/{id}/tags#

Gets the list of Tags for the resource

Parameters

  • id (integer) – ID for the ml_model.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/models/{id}/tags#

Replaces one or more Tags to the resource

Parameters

  • id (integer) – ID for the ml_model.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/models/{id}/tags#

Appends one or more Tags to the resource

Parameters

  • id (integer) – ID for the ml_model.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/models/{id}/tags#

Removes all Tags from the resource

Parameters

  • id (integer) – ID for the ml_model.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/models/{id}/tags/{tagId}#

Removes a Tag from the resource

Parameters

  • tagId (integer) – ID for the Tag.

  • id (integer) – ID for the ml_model.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/models/{id}/versions#

Gets a list of versions of this Model resource

Parameters

  • id (integer) – ID for the Models resource.

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/models/{id}/versions#

Creates a new version of the model resource

Parameters

  • id (integer) – ID for the Models resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/models/{id}/versions/{versionNumber}#

Gets a specific version of a model by version number

Parameters

  • versionNumber (integer) – Version number for the Model resource.

  • id (integer) – ID for the Model resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/models/{id}/versions/{versionNumber}#

Modifies specific version of the model resource

Parameters

  • versionNumber (integer) – Version number for the Model resource.

  • id (integer) – ID for the Model resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PluginParameterTypes#

PluginParameterType management operations.

Endpoints#

The following is the list of endpoints under the /api/v1/pluginParameterType/ namespace.

GET /api/v1/pluginParameterTypes/#

Gets a list of all PluginParameterType resources

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/pluginParameterTypes/#

Creates a PluginParameterType resource

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/pluginParameterTypes/drafts/#

Gets the Drafts for the resource

Query Parameters

  • draftType (string) – The type of drafts to return: all, existing, or new.

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/pluginParameterTypes/drafts/#

Creates a Draft for the resource

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/pluginParameterTypes/drafts/{draftId}#

Gets a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the plugin_task_parameter_type resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/pluginParameterTypes/drafts/{draftId}#

Modifies a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the plugin_task_parameter_type resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/pluginParameterTypes/drafts/{draftId}#

Deletes a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the plugin_task_parameter_type resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/pluginParameterTypes/{id}#

Gets a PluginParameterType resource

Parameters

  • id (integer) – ID for the PluginParameterType resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/pluginParameterTypes/{id}#

Modifies a PluginParameterType resource

Parameters

  • id (integer) – ID for the PluginParameterType resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/pluginParameterTypes/{id}#

Deletes a PluginParameterType resource

Parameters

  • id (integer) – ID for the PluginParameterType resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/pluginParameterTypes/{id}/draft#

Gets the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/pluginParameterTypes/{id}/draft#

Modifies the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/pluginParameterTypes/{id}/draft#

Creates a Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/pluginParameterTypes/{id}/draft#

Deletes the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/pluginParameterTypes/{id}/snapshots#

Gets the Snapshots for the resource

Parameters

  • id (integer) – ID for the plugin_task_parameter_type resource.

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/pluginParameterTypes/{id}/snapshots/{snapshotId}#

Gets a Snapshot for the resource by snapshot id

Parameters

  • snapshotId (integer) – Snapshot ID for the plugin_task_parameter_type resource.

  • id (integer) – ID for the plugin_task_parameter_type resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/pluginParameterTypes/{id}/tags#

Gets the list of Tags for the resource

Parameters

  • id (integer) – ID for the plugin_task_parameter_type.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/pluginParameterTypes/{id}/tags#

Replaces one or more Tags to the resource

Parameters

  • id (integer) – ID for the plugin_task_parameter_type.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/pluginParameterTypes/{id}/tags#

Appends one or more Tags to the resource

Parameters

  • id (integer) – ID for the plugin_task_parameter_type.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/pluginParameterTypes/{id}/tags#

Removes all Tags from the resource

Parameters

  • id (integer) – ID for the plugin_task_parameter_type.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/pluginParameterTypes/{id}/tags/{tagId}#

Removes a Tag from the resource

Parameters

  • tagId (integer) – ID for the Tag.

  • id (integer) – ID for the plugin_task_parameter_type.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

Plugins#

Plugins management operations.

Endpoints#

The following is the list of endpoints under the /api/v1/plugins/ namespace.

GET /api/v1/plugins/#

Gets a list of all Plugin resources

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/plugins/#

Creates a Plugin resource

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/drafts/#

Gets the Drafts for the resource

Query Parameters

  • draftType (string) – The type of drafts to return: all, existing, or new.

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/plugins/drafts/#

Creates a Draft for the resource

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/drafts/{draftId}#

Gets a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the plugin resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/plugins/drafts/{draftId}#

Modifies a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the plugin resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/plugins/drafts/{draftId}#

Deletes a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the plugin resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/{id}#

Gets a Plugin resource

Parameters

  • id (integer) – ID for the Plugin resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/plugins/{id}#

Modifies a Plugin resource

Parameters

  • id (integer) – ID for the Plugin resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/plugins/{id}#

Deletes a Plugin resource

Parameters

  • id (integer) – ID for the Plugin resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/{id}/draft#

Gets the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/plugins/{id}/draft#

Modifies the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/plugins/{id}/draft#

Creates a Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/plugins/{id}/draft#

Deletes the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/{id}/files#

Gets a list of all PluginFile resources for a Plugin resource

Parameters

  • id (integer) – ID for the Plugin resource.

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/plugins/{id}/files#

Creates a PluginFile resource associated with a Plugin resource

Parameters

  • id (integer) – ID for the Plugin resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/plugins/{id}/files#

Deletes all PluginFile resources associated with a Plugin resource

Parameters

  • id (integer) – ID for the Plugin resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/{id}/files/drafts/#

Gets the Drafts for the resource

Parameters

  • id (integer) –

Query Parameters

  • draftType (string) – The type of drafts to return: all, existing, or new.

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/plugins/{id}/files/drafts/#

Creates a Draft for the resource

Parameters

  • id (integer) –

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/{id}/files/drafts/{draftId}#

Gets a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the plugin_file resource.

  • id (integer) –

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/plugins/{id}/files/drafts/{draftId}#

Modifies a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the plugin_file resource.

  • id (integer) –

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/plugins/{id}/files/drafts/{draftId}#

Deletes a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the plugin_file resource.

  • id (integer) –

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/{id}/files/{fileId}#

Gets a PluginFile resource

Parameters

  • fileId (integer) – ID for the PluginFile resource.

  • id (integer) – ID for the Plugin resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/plugins/{id}/files/{fileId}#

Modifies a PluginFile resource

Parameters

  • fileId (integer) – ID for the PluginFile resource.

  • id (integer) – ID for the Plugin resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/plugins/{id}/files/{fileId}#

Deletes a PluginFile resource

Parameters

  • fileId (integer) – ID for the PluginFile resource.

  • id (integer) – ID for the Plugin resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/{id}/files/{fileId}/draft#

Gets the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

  • fileId (integer) –

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/plugins/{id}/files/{fileId}/draft#

Modifies the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

  • fileId (integer) –

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/plugins/{id}/files/{fileId}/draft#

Creates a Draft for this resource

Parameters

  • id (integer) – ID for the resource.

  • fileId (integer) –

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/plugins/{id}/files/{fileId}/draft#

Deletes the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

  • fileId (integer) –

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/{id}/files/{fileId}/snapshots#

Gets the Snapshots for the resource

Parameters

  • fileId (integer) – ID for the plugin_file.

  • id (integer) – ID for the plugin_file.

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/{id}/files/{fileId}/snapshots/{snapshotId}#

Gets a Snapshot for the resource by snapshot id

Parameters

  • snapshotId (integer) – ID for the Snapshot.

  • fileId (integer) – ID for the plugin_file.

  • id (integer) – ID for the plugin_file.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/{id}/files/{fileId}/tags/#

Gets the list of Tags for the resource

Parameters

  • fileId (integer) – ID for the plugin_file.

  • id (integer) – ID for the plugin.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/plugins/{id}/files/{fileId}/tags/#

Replaces one or more Tags to the resource

Parameters

  • fileId (integer) – ID for the plugin_file.

  • id (integer) – ID for the plugin.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/plugins/{id}/files/{fileId}/tags/#

Appends one or more Tags to the resource

Parameters

  • fileId (integer) – ID for the plugin_file.

  • id (integer) – ID for the plugin.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/plugins/{id}/files/{fileId}/tags/#

Removes all Tags from the resource

Parameters

  • fileId (integer) – ID for the plugin_file.

  • id (integer) – ID for the plugin.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/plugins/{id}/files/{fileId}/tags/{tagId}#

Removes a Tag from the resource

Parameters

  • tagId (integer) – ID for the Tag.

  • fileId (integer) – ID for the plugin_file.

  • id (integer) – ID for the plugin.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/{id}/snapshots#

Gets the Snapshots for the resource

Parameters

  • id (integer) – ID for the plugin resource.

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/{id}/snapshots/{snapshotId}#

Gets a Snapshot for the resource by snapshot id

Parameters

  • snapshotId (integer) – Snapshot ID for the plugin resource.

  • id (integer) – ID for the plugin resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/plugins/{id}/tags#

Gets the list of Tags for the resource

Parameters

  • id (integer) – ID for the plugin.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/plugins/{id}/tags#

Replaces one or more Tags to the resource

Parameters

  • id (integer) – ID for the plugin.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/plugins/{id}/tags#

Appends one or more Tags to the resource

Parameters

  • id (integer) – ID for the plugin.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/plugins/{id}/tags#

Removes all Tags from the resource

Parameters

  • id (integer) – ID for the plugin.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/plugins/{id}/tags/{tagId}#

Removes a Tag from the resource

Parameters

  • tagId (integer) – ID for the Tag.

  • id (integer) – ID for the plugin.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

Queues#

Queues management operations.

Endpoints#

The following is the list of endpoints under the /api/v1/queues/ namespace.

GET /api/v1/queues/#

Gets a list of all Queue resources

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/queues/#

Creates a Queue resource

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/queues/drafts/#

Gets the Drafts for the resource

Query Parameters

  • draftType (string) – The type of drafts to return: all, existing, or new.

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/queues/drafts/#

Creates a Draft for the resource

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/queues/drafts/{draftId}#

Gets a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the queue resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/queues/drafts/{draftId}#

Modifies a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the queue resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/queues/drafts/{draftId}#

Deletes a Draft for the resource

Parameters

  • draftId (integer) – ID for the Draft of the queue resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/queues/{id}#

Gets a Queue resource

Parameters

  • id (integer) – ID for the Queue resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/queues/{id}#

Modifies a Queue resource

Parameters

  • id (integer) – ID for the Queue resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/queues/{id}#

Deletes a Queue resource

Parameters

  • id (integer) – ID for the Queue resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/queues/{id}/draft#

Gets the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/queues/{id}/draft#

Modifies the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/queues/{id}/draft#

Creates a Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/queues/{id}/draft#

Deletes the Draft for this resource

Parameters

  • id (integer) – ID for the resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/queues/{id}/snapshots#

Gets the Snapshots for the resource

Parameters

  • id (integer) – ID for the queue resource.

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/queues/{id}/snapshots/{snapshotId}#

Gets a Snapshot for the resource by snapshot id

Parameters

  • snapshotId (integer) – Snapshot ID for the queue resource.

  • id (integer) – ID for the queue resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/queues/{id}/tags#

Gets the list of Tags for the resource

Parameters

  • id (integer) – ID for the queue.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/queues/{id}/tags#

Replaces one or more Tags to the resource

Parameters

  • id (integer) – ID for the queue.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/queues/{id}/tags#

Appends one or more Tags to the resource

Parameters

  • id (integer) – ID for the queue.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/queues/{id}/tags#

Removes all Tags from the resource

Parameters

  • id (integer) – ID for the queue.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/queues/{id}/tags/{tagId}#

Removes a Tag from the resource

Parameters

  • tagId (integer) – ID for the Tag.

  • id (integer) – ID for the queue.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

Tags#

Tag management operations.

Endpoints#

The following is the list of endpoints under the /api/v1/tags/ namespace.

GET /api/v1/tags/#

Gets a list of all Tags

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • groupId (integer) – Filter results by the Group ID.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/tags/#

Creates a Tag

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/tags/{id}#

Gets a Tag

Parameters

  • id (integer) – ID for the Tag.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/tags/{id}#

Modifies a Tag

Parameters

  • id (integer) – ID for the Tag.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/tags/{id}#

Deletes a Tag

Parameters

  • id (integer) – ID for the Tag.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/tags/{id}/resources/#

Gets all Resources labeled with this Tag

Parameters

  • id (integer) – ID for the Tag.

Query Parameters

  • resourceType (string) – Filter results by the type of resource.

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

Users#

User management operations.

Endpoints#

The following is the list of endpoints under the /api/v1/users/ namespace.

GET /api/v1/users/#

Gets a list of all Users

Query Parameters

  • search (string) – Search terms for the query (* and ? wildcards).

  • index (integer) – Index of the current page.

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

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/users/#

Creates a User

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/users/current#

Gets the Current User

Status Codes
Request Headers

  • X-Fields – An optional fields mask

PUT /api/v1/users/current#

Modifies the Current User

Status Codes
Request Headers

  • X-Fields – An optional fields mask

DELETE /api/v1/users/current#

Deletes a Current User

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/users/current/password#

Updates the Current User’s password

Status Codes
Request Headers

  • X-Fields – An optional fields mask

GET /api/v1/users/{id}#

Gets the User with the provided ID

Parameters

  • id (integer) – ID for the User resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

POST /api/v1/users/{id}/password#

Updates the User’s password with a given ID

Parameters

  • id (integer) – ID for the User resource.

Status Codes
Request Headers

  • X-Fields – An optional fields mask

Workflows#

Workflow execution operations.

Endpoints#

The following is the list of endpoints under the /api/v1/workflows/ namespace.

GET /api/v1/workflows/jobFilesDownload#

Download a compressed file archive containing the files needed to execute a submitted job

Query Parameters

  • jobId (string) – A job’s unique identifier.

  • fileType (string) – The type of file to download: tar_gz or zip.

Status Codes