OneCloud API
by ryancurtin

OneCloud API

APIs for controlling the execution of chains and fetching security and application metadata
Operations
workspace

Workspace metadata

Gets a list of workspaces
GET /metadata/workspace
Get workspace properties
GET /metadata/workspace/{workspace_id}
Gets a list of workspaces
GET /metadata/workspace

Authentication

Auth Token

Responses

200 200

successful operation

Body
application/json
Object
data
Array of Workspace
401 401

unauthorized

Body
application/json
SingleError
Get workspace properties
GET /metadata/workspace/{workspace_id}

Authentication

oauth2

Path variables

workspace_id
integer required

workspace id

Responses

200 200

successful operation

Body
application/json
Object
data
Workspace
401 401

unauthorized

Body
application/json
SingleError
404 404

not_found

Body
application/json
SingleError
environment

Workspace environment metadata

Gets a list of environments
GET /metadata/workspace/{workspace_id}/environment
Get environment properties
GET /metadata/workspace/{workspace_id}/environment/{environment_id}
Gets a list of environments
GET /metadata/workspace/{workspace_id}/environment

Authentication

oauth2

Path variables

workspace_id
integer required

Workspace ID

Responses

200 200

successful operation

Body
application/json
Object
data
Array of Environment
401 401

unauthorized

Body
application/json
SingleError
404 404

not_found

Body
application/json
SingleError
Get environment properties
GET /metadata/workspace/{workspace_id}/environment/{environment_id}

Authentication

oauth2

Path variables

workspace_id
integer required

Workspace ID

environment_id
integer required

Environment ID

Responses

200 200

successful operation

Body
application/json
Object
data
Environment
401 401

unauthorized

Body
application/json
SingleError
404 404

not_found

Body
application/json
SingleError
chain

Chain metadata

Get a list of chains in the environment
GET /metadata/environment/{environment_id}/chain
Get chain properties
GET /metadata/environment/{environment_id}/chain/{chain_id}
Get a list of chains in the environment
GET /metadata/environment/{environment_id}/chain

Authentication

oauth2

Path variables

environment_id
integer required

Environment ID

Responses

200 200

successful operation

Body
application/json
Object
data
Array of Chain
401 401

unauthorized

Body
application/json
SingleError
404 404

not_found

Body
application/json
SingleError
Get chain properties
GET /metadata/environment/{environment_id}/chain/{chain_id}

Authentication

oauth2

Path variables

environment_id
string required

Environment ID

chain_id
string required

Chain ID

Responses

200 200

successful operation

Body
application/json
Object
data
Chain
401 401

unauthorized

Body
application/json
SingleError
404 404

not_found

Body
application/json
SingleError
execution

Chain execution (start, stop, status, history)

Start a chain
POST /execute/environment/{environment_id}/chain/{chain_id}/start
Get a chains run history
GET /execute/environment/{environment_id}/chain/{chain_id}/history
Search previous chain runs for an input value
GET /execute/environment/{environment_id}/chain/inputs_search
Gets details of a chainRun
GET /execute/chain_run/{chain_run_id}
Stop a currently running chain
POST /execute/chain_run/{chain_run_id}/stop
Start a chain
POST /execute/environment/{environment_id}/chain/{chain_id}/start

Authentication

oauth2

Path variables

environment_id
integer required

Environment ID

chain_id
string required

Chain ID

Request body

application/json
Object
runtimeVariables
RuntimeVariables

Responses

200 200

successful operation

Body
application/json
Object
data
ChainRun
401 401

unauthorized

Body
application/json
SingleError
404 404

not_found

Body
application/json
SingleError
422 422

unable to start chain

Body
application/json
SingleError
Get a chains run history
GET /execute/environment/{environment_id}/chain/{chain_id}/history

Authentication

oauth2

Path variables

environment_id
integer required

Environment ID

chain_id
string required

Chain ID

Request parameters

limit
integer optional

limit number of chainRuns returned (Max 50)

cursor
string optional

cursor value returned from the API, indicating page information

Responses

200 200

successful operation

Body
application/json
Object
data
ChainRunPage
401 401

unauthorized

Body
application/json
SingleError
404 404

not_found

Body
application/json
SingleError
Search previous chain runs for an input value
GET /execute/environment/{environment_id}/chain/inputs_search

Authentication

oauth2

Path variables

environment_id
integer required

Environment ID

Request parameters

search_text
string required

An input value for previous chain runs

limit
integer optional

limit number of chainExecutors returned (Max 50)

cursor
string optional

cursor value returned from the API, indicating page information

Responses

200 200

successful operation

Body
application/json
Object
data
ChainRunPage
401 401

unauthorized

Body
application/json
SingleError
404 404

not_found

Body
application/json
SingleError
422 422

unable to start chain

Body
application/json
SingleError
Gets details of a chainRun
GET /execute/chain_run/{chain_run_id}

Authentication

oauth2

Path variables

chain_run_id
integer required

Chain Run ID

Responses

200 200

successful operation

Body
application/json
Object
data
ChainRun
401 401

unauthorized

Body
application/json
SingleError
404 404

not_found

Body
application/json
SingleError
Stop a currently running chain
POST /execute/chain_run/{chain_run_id}/stop

Authentication

oauth2

Path variables

chain_run_id
integer required

Chain Run ID

Responses

200 200

successful operation

Body
application/json
Object
data
ChainRun
401 401

unauthorized

Body
application/json
SingleError
404 404

not_found

Body
application/json
SingleError
422 422

unable to stop chain

Body
application/json
SingleError
security

Security API

Gets a list of login activity events
GET /security/login_activity
Gets a list of authorization related activities
GET /security/authorizations_activity
Gets a list of login activity events
GET /security/login_activity

Authentication

oauth2

Request parameters

pageSize
integer optional

limit number of results returned (Max 100)

page
string optional

page number to retrieve in the paginated results

Responses

200 200

successful operation

Body
application/json
Object
data
Array of LoginActivity
401 401

unauthorized

Body
application/json
SingleError
Gets a list of authorization related activities
GET /security/authorizations_activity

Authentication

oauth2

Request parameters

pageSize
integer optional

limit number of results returned (Max 100)

page
string optional

page number to retrieve in the paginated results

Responses

200 200

successful operation

Body
application/json
Object
data
Array of Activity
401 401

unauthorized

Body
application/json
SingleError
Type Definitions
SingleError
Object
error
string
error_description
string
RuntimeVariables
Object
yourVariable
string
Activity
Object
id
integer int64
trackable_type
string
trackable_id
integer int64
owner_type
string
owner_id
integer int64
key
string
parameters
Object
recipient_type
string
recipient_id
integer int64
created_at
string date-time
updated_at
string date-time
LoginActivity
Object
id
integer int64
identity
string
context
string
success
boolean
failure_reason
string
user_id
integer int64
ip
string
city
string
region
string
country
string
created_at
string date-time
Chain
Object
id
string
name
string
description
string
execution_type
string
Enumeration:
schedule
trigger
manual
ChainRun
Object
id
string
chain_id
string
user_id
integer int64
user_name
string
started_at
string date-time
ended_at
string date-time
paused_at
string date-time
resumed_at
string date-time
state
string
Enumeration:
sleeping
enqueueing
paused
errored
warned
all_succeeded
stopped
execution_type
string
Enumeration:
schedule
trigger
manual
launch_type
string
Enumeration:
manual
api
schedule
trigger
slack
trigger_event
ChainRunPage
Object
cursor
string
chain_executors
Array of ChainRun
Workspace
Object
id
integer int64
name
string
description
string
variables
Array of Variable
Environment
Object
id
integer int64
name
string
description
string
position
integer int64
variables
Array of Variable
settings
Object
color
string
Variable
Object
key
string
label
string
defaultValue
string
value
string
encrypted
boolean