API docs by Redocly

Globus Actions API (2024-03-14.1)

Download OpenAPI specification:Download

Globus Support: support@globus.org URL: https://support.globus.org/hc/en-us/requests/new Terms of Service

This is the Globus Actions API description. Implementation of this API renders a service compatible for use in the Globus Automate service.

/

Introspect the Action Provider for invocation, aut

Introspect the Action Provider for invocation, authorization, administrative and other information. Depending on the Action Provider configuration, this endpoint may allow unauthenticated access.

Authorizations:
bearer_token

Responses

Response samples

Content type
application/json
{
  • "types": [
    ],
  • "api_version": "1.0",
  • "globus_auth_scope": "http://example.com",
  • "title": "string",
  • "subtitle": "string",
  • "description": "string",
  • "keywords": [
    ],
  • "visible_to": [
    ],
  • "runnable_by": [
    ],
  • "administered_by": [
    ],
  • "admin_contact": "string",
  • "synchronous": true,
  • "log_supported": true,
  • "maximum_deadline": "string",
  • "input_schema": { },
  • "event_types": [
    ]
}

/run

Trigger an Action execution.

Trigger an Action execution.

Authorizations:
bearer_token
Request Body schema: application/json
required
request_id
required
string

A unique identifier representing the request to start an action. Multiple uses of the same request_id must have the same content or they will be rejected. Only one instance of the operation will be executed, so requests with the same request_id may be repeated to attempt to guarantee execution of an action.

body
required
object

The action-provider specific content describing the action to run. Format for the body may be provided in the input_schema field of the Action Provider Description.

label
string [ 1 .. 64 ] characters

A short human presentable description of the Action requested.

monitor_by
Array of strings (PrincipalURN) unique [^urn:globus:(auth:identity|groups:id):([a-fA-...]

A list of principal URNs containing identities which are allowed to monitor the progress of the action using the /status and /log operations. When not provided, defaults to the user that initiated the action.

manage_by
Array of strings (PrincipalURN) unique [^urn:globus:(auth:identity|groups:id):([a-fA-...]

A list of principal URN containing identities which are allowed to manage the progress of the action using the /cancel and /release operations. When not provided, defaults to the user that initiated the action.

allowed_clients
Array of strings (AllowedClients) [^(public|globus|creator|.$)$]
deadline
string <date-time>

A timestamp indicating by which time the action must complete. The request may be rejected if the Action Provider does not expect to be able to complete the action before the deadline or if it represents a time greater than the maximum_deadline specified in the Provider Description.

release_after
string (ISO8601_duration) ^P(?!$)(\d+(?:\.\d+)?Y)?(\d+(?:\.\d+)?M)?(\d+...

ISO8601 duration format. Regex sourced from https://stackoverflow.com/a/32045167/845210.

Responses

Request samples

Content type
application/json
{
  • "request_id": "string",
  • "body": { },
  • "label": "string",
  • "monitor_by": [
    ],
  • "manage_by": [
    ],
  • "allowed_clients": [
    ],
  • "deadline": "2019-08-24T14:15:22Z",
  • "release_after": "string"
}

Response samples

Content type
application/json
{
  • "action_id": "6529",
  • "status": "ACTIVE",
  • "creator_id": "urn:globus:auth:identity:ae2a1750-d274-11e5-b867-e74762c29f57",
  • "details": {
    },
  • "manage_by": [
    ],
  • "monitor_by": [
    ],
  • "release_after": "P30D",
  • "start_time": "2019-06-21T17:01:55.806781+00:00"
}

/status

Get the status for a previously executed Action.

Get the status for a previously executed Action.

Authorizations:
bearer_token
path Parameters
action_id
required
string

The ID for the Action for which to check the status.

Responses

Response samples

Content type
application/json
{
  • "action_id": "6529",
  • "status": "ACTIVE",
  • "creator_id": "urn:globus:auth:identity:ae2a1750-d274-11e5-b867-e74762c29f57",
  • "details": {
    },
  • "manage_by": [
    ],
  • "monitor_by": [
    ],
  • "release_after": "P30D",
  • "start_time": "2019-06-21T17:01:55.806781+00:00"
}

/cancel

Cancel a running Action.

Cancel a running Action.

Authorizations:
bearer_token
path Parameters
action_id
required
string

The ID for the Action that will be cancelled.

Responses

Response samples

Content type
application/json
{
  • "action_id": "6529",
  • "status": "ACTIVE",
  • "creator_id": "urn:globus:auth:identity:ae2a1750-d274-11e5-b867-e74762c29f57",
  • "details": {
    },
  • "manage_by": [
    ],
  • "monitor_by": [
    ],
  • "release_after": "P30D",
  • "start_time": "2019-06-21T17:01:55.806781+00:00"
}

/release

Remove the action's state from the Action Provider

Remove the action's state from the Action Provider's execution store.

Authorizations:
bearer_token
path Parameters
action_id
required
string

The ID for the Action that will be removed from the Action Provider's execution history.

Responses

Response samples

Content type
application/json
{
  • "action_id": "6529",
  • "status": "ACTIVE",
  • "creator_id": "urn:globus:auth:identity:ae2a1750-d274-11e5-b867-e74762c29f57",
  • "details": {
    },
  • "manage_by": [
    ],
  • "monitor_by": [
    ],
  • "release_after": "P30D",
  • "start_time": "2019-06-21T17:01:55.806781+00:00"
}