Cisco Orbital

Gets the results of an Orbital job.

Target: Orbital - v0 integration target or an HTTP Endpoint for "orbital.amp.cisco.com" with a path of "/v0"

Account Key: None if using an integration-provided target, access token if using an HTTP Endpoint

Steps:
[] Generate the authorization header
[] Attempt to fetch the job results from Orbital
[] Check if the request was successful:
[]> If it was, set the output variables
[]> If it wasn't, output an error

More information about this API: https://developer.cisco.com/docs/orbital/results/

Cisco Orbital - Query - Get Job Results

prod-nam

prod-eu

prod-apjc

Gets the status of an Orbital job.

Target: Orbital - v0 integration target or an HTTP Endpoint for "orbital.amp.cisco.com" with a path of "/v0"

Account Key: None if using an integration-provided target, access token if using an HTTP Endpoint

Steps:
[] Generate the authorization header
[] Attempt to fetch the job status from Orbital
[] Check if the job was successful:
[]> If it was, set the output variables
[]> If it wasn't, output an error

More information about this API: https://developer.cisco.com/docs/orbital/get-status-information-about-a-job/

Cisco Orbital - Query - Get Job Status by ID

Executes an Orbital catalog query or SQL query on one or more endpoints. Waiting for the query to complete is optional.

Target: Orbital - v0 integration target or an HTTP Endpoint for "orbital.amp.cisco.com" with a path of "/v0"

Account Key: None if using an integration-provided target, access token if using an HTTP Endpoint

Steps:
[] Validate required input
[] Build the endpoint identifier for the query
[] Validate that an identifier or node list was provided
[] Build the request payload
[] Send the query request to Orbital
[] Check if the job was started
[] Get the job ID and add it to an output variable
[] Check if we're waiting for the query to finish (if not, end the workflow)
[] Loop until the Orbital job finishes or expires
[]> Check if the job expired (if it did, end the workflow)
[]> Attempt to fetch job results
[]> Check if a result was obtained (if not, sleep for 1 second and try again)

More information about this API: https://developer.cisco.com/docs/orbital/query/

Cisco Orbital - Query - Run Query

Executes an Orbital catalog query or SQL query on all endpoints. Waiting for the query to complete is optional.

Target: Orbital - v0 integration target or an HTTP Endpoint for "orbital.amp.cisco.com" with a path of "/v0"

Account Key: None if using an integration-provided target, access token if using an HTTP Endpoint

Steps:
[] Validate required input
[] Build the endpoint identifier for the query
[] Validate that an identifier was provided
[] Build the request payload
[] Send the query request to Orbital
[] Check if the job was started
[] Get the job ID and add it to an output variable
[] Check if we're waiting for the query to finish (if not, end the workflow)
[] Loop until the Orbital job finishes or expires
[]> Check if the job expired (if it did, end the workflow)
[]> Attempt to fetch job results
[]> Check if a result was obtained (if not, sleep for 1 second and try again)

More information about this API: https://developer.cisco.com/docs/orbital/catalogqueryresponse/

Cisco Orbital - Query - Run Query (All Endpoints)

Cancels a script execution job in Orbital.

Target: Orbital - v0 integration target or an HTTP Endpoint for "orbital.amp.cisco.com" with a path of "/v0"

Account Key: None if using an integration-provided target, access token if using an HTTP Endpoint

Steps:
[] Generate the authorization header
[] Attempt to delete the script job
[] Check if the job was successful:
[]> If it wasn't, output an error

More information about this API: https://developer.cisco.com/docs/orbital/delete-a-script-job/

Cisco Orbital - Script - Cancel Job

Gets the results of a script execution job from Orbital.

Target: Orbital - v0 integration target or an HTTP Endpoint for "orbital.amp.cisco.com" with a path of "/v0"

Account Key: None if using an integration-provided target, access token if using an HTTP Endpoint

Steps:
[] Generate the authorization header
[] Attempt to fetch the job results from Orbital
[] Check if the job was successful:
[]> If it was, set the output variables
[]> If it wasn't, output an error

More information about this API: https://developer.cisco.com/docs/orbital/returns-results-of-a-particular-query/

Cisco Orbital - Script - Get Job Results

Gets the status of a script execution job from Orbital.

Target: Orbital - v0 integration target or an HTTP Endpoint for "orbital.amp.cisco.com" with a path of "/v0"

Account Key: None if using an integration-provided target, access token if using an HTTP Endpoint

Steps:
[] Generate the authorization header
[] Attempt to fetch the job status from Orbital
[] Check if the job was successful:
[]> If it was, set the output variables
[]> If it wasn't, output an error

More information about this API: https://developer.cisco.com/docs/orbital/fetch-script-job-info/

Cisco Orbital - Script - Get Job by ID

Gets a list of scripts from your organization's Orbital script catalog. These are scripts that your organization has created, not stock scripts from Cisco. Stock scripts can be found using the "Orbital - Get Stock Catalog Scripts" atomic.

Target: Orbital - v0 integration target or an HTTP Endpoint for "orbital.amp.cisco.com" with a path of "/v0"

Account Key: None if using an integration-provided target, access token if using an HTTP Endpoint

Steps:
[] Generate the authorization header
[] Attempt to fetch the script list from Orbital
[] Check if the request was successful:
[]> If it was, set the output variables
[]> If it wasn't, output an error

More information about this API: https://developer.cisco.com/docs/orbital/fetch-all-organization-catalog-scripts/

Cisco Orbital - Script - Get Organization Catalog Scripts

Gets a list of scripts written by Cisco from your Orbital script catalog.

Target: Orbital - v0 integration target or an HTTP Endpoint for "orbital.amp.cisco.com" with a path of "/v0"

Account Key: None if using an integration-provided target, access token if using an HTTP Endpoint

Steps:
[] Generate the authorization header
[] Attempt to fetch the script list from Orbital
[] Check if the request was successful:
[]> If it was, set the output variables
[]> If it wasn't, output an error

More information about this API: https://developer.cisco.com/docs/orbital/fetch-all-catalog-stock-scripts/

Cisco Orbital - Script - Get Stock Catalog Scripts

Executes an Orbital script on one or more endpoints.

Target: Orbital - v0 integration target or an HTTP Endpoint for "orbital.amp.cisco.com" with a path of "/v0"

Account Key: None if using an integration-provided target, access token if using an HTTP Endpoint

Steps:
[] Validate required input
[] Build the endpoint identifier for the script
[] Validate that an identifier or node list was provided
[] Build the request payload
[] Send the script request to Orbital
[] Check if the request was successful:
[]> If it was, extract the job ID and set the output variable
[]> If it wasn't, output an error

More information about this API: https://developer.cisco.com/docs/orbital/live-execution-of-a-script/