Skip to main content
System StatusContact Support
VersionOne Community

Continuum REST API Reference

Overview 

Comprehensive Continuum Rest  API reference list.

Jump to a Section

Automate

add_cloud_keypair

Adds a Key Pair to a Cloud.

Required Arguments:

  • cloud - Name or ID of the Cloud to update.
  • name - a name for the Key Pair.
  • private_key - the private key.

Optional Arguments:

  • passphrase - a passphrase for this Key Pair.

Returns: A list of Cloud KeyPair Objects.

create_account

Creates a Cloud Account.

Required Arguments:

  • name - a name for the new Account.
  • provider - one of the valid cloud providers.
  • login - the login id (access key) for this Account.
  • password - a password (secret key) for this Account.
  • default_cloud - the name of a default Cloud for this Account.

Optional Arguments:

  • account_number - an Account number.

Returns: The new Cloud Account Object.

create_asset

Creates an Asset.

Required Arguments:

  • name - a name for the new Asset.

Optional Arguments:

  • status - either 'Active' or 'Inactive'. ('Active' if omitted.)
  • db_name - a Database name.
  • address - the network address of the Asset.
  • port - a service port for the Address.
  • conn_string - some Assets make their connections via an explicit connection string.
  • user - a User ID to associate with this Asset.
  • password - a Password to associate with this Asset.
  • shared_credential - the name of a Shared Credential to use.

Regarding Credentials:

Credentials are optional on an Asset, however if provided there are rules. Explicit details can be associated with only this Asset, or a Shared Credential can be specified.

The minimum required to create a LOCAL set of credentials on this Asset are:

  • user - a User ID for the Credential
  • password - a Password for the Credential

To specify a Shared Credential, provide the shared_credential argument, which is the name of an existing Credential.

Returns: An Asset Object.

create_cloud

Creates a Cloud.

Required Arguments:

  • name - a name for the new Cloud.
  • provider - one of the valid cloud providers.
  • apiurl - URL of the Cloud API endpoint.
  • apiprotocol - Cloud API endpoint protocol.

Optional Arguments:

  • default_account - the name of a default Account for this Cloud.

Returns: The new Cloud Object.

create_credential

Creates a new Shared Credential.

Only a 'Developer' can create Credentials.

Required Arguments:

  • name - The full name of the user.
  • username - A login name for the user.
  • password - Password for the user. If password is not provided, a random password will be generated.

Optional Arguments:

  • description - Description of the Credential.
  • domain - A domain for the Credential.

Returns: A Credential Object.

create_document

Creates a Datastore document.

Optional Arguments:

  • collection - a document collection. 'Default' if omitted.
  • template - A JSON document template. A blank document will be created if omitted.

Returns: A Datastore Document Object.

create_task

Create a new Task.

Required Arguments:

  • name - a name for the new Task.

Optional Arguments:

  • code - a Task code.
  • desc - a Task description.

Returns: A Task Object.

create_task_from_json

Create a new Task from a JSON Task backup document.

Required Arguments:

  • json - A properly formatted JSON representation of a Task.

Returns: A Task Object.

delete_asset

Deletes an Asset.

Required Arguments:

  • asset - Either the Asset ID or Name.

Returns: Nothing if successful, error messages on failure.

delete_cloud_keypair

Removes a Key Pair from a Cloud.

Required Arguments:

  • cloud - Name or ID of the Cloud.
  • name - Name of the Key Pair to delete.

Returns: A list of Cloud KeyPair Objects.

delete_credential

Removes a Shared Credential.

Required Arguments:

  • credential - Name or ID of the Credential to delete.

Returns: Success message if successful, error message on failure.

delete_plan

Deletes a specific queued execution Plan.

Required Arguments:

  • plan_id - The integer ID of the Plan to delete.

Returns: Nothing if successful, error messages on failure.

delete_schedule

Deletes a Task Schedule and all queued execution Plans.

Required Arguments:

  • schedule_id - The UUID of the Schedule to delete.

Returns: Nothing if successful, error messages on failure.

delete_task

Deletes all versions of a Task.

Required Arguments:

  • task - Either the Task ID or Name.

Optional Arguments:

  • force_delete - Delete the Task, even if there are historical rows and references. (Valid values: 1, yes, true)

Returns: Nothing if successful, error messages on failure.

describe_task_parameters

Describes the Parameters for a Task.

Required Arguments:

  • task - Value can be either a Task ID, Code or Name.

Optional Arguments:

  • version - A specific version. ('Default' if omitted.)

Returns: A help document describing the Task Parameters.

export_task

Create a backup file for a single Task.

The behavior of this command is different depending on the Accept header.

  • If 'application/json' (default), it will return a JSON list of individual Task documents.
  • If 'application/xml' OR 'text/plain', it will return an XML document of Tasks.

Required Arguments:

  • task - Value can be either a Task ID, Code or Name.

Optional Arguments:

  • version` - A specific version. ('Default' if omitted.)
  • include_refs` - If true, will analyze each task and include any referenced Tasks.

Returns: A collection of Task backup objects.

get_account

Gets a Cloud Account.

Required Arguments:

  • name - a Cloud Account name or ID.

Returns: A Cloud Account Object.

get_asset

Gets an Asset.

Required Arguments:

  • asset - an Asset Name or ID.

Returns: An Asset Object.

get_cloud

Gets a Cloud object.

Required Arguments:

  • name - a Cloud name or ID.

Returns: A Cloud Object.

get_document

Gets a Datastore document.

Required Arguments:

  • query - A query in JSON format to select the correct Document.

Optional Arguments:

  • collection - a document collection. 'Default' if omitted.

Returns: A Datastore Document Object.

get_document_value

Gets the value of a key in a Datastore document.

Datastore queries always return a list of document matches, even if the result set happens to only return data from one document.

Required Arguments:

  • query - A query in JSON format to select the correct Document.
  • lookupkey - The section of the Document to retrieve. Returns the entire document if omitted.

Optional Arguments:

  • collection - a document collection. 'Default' if omitted.

Returns: A text value.

get_task

Gets a Task object.

Required Arguments:

  • task - Value can be either a Task ID or Name.

Optional Arguments:

  • version - A specific version. ('Default' if omitted.)
  • include_code - Whether to include Codeblocks and Steps. (Only included if 'output_format' is 'json' or 'xml'. 'False' if omitted.)

Returns: A Task Object.

get_task_instance

Gets the details of a Task Instance.

Required Arguments:

  • instance - The Task Instance identifier.

Returns: A Task Instance Object.

get_task_instance_status

Gets just the Status of a Task Instance.

Required Arguments:

  • instance - The Task Instance identifier.

Returns: The 'Status' from a Task Instance Object.

get_task_instances

Gets a list of Task Instances.

Optional Arguments:

  • filter - A filter to limit the results.
  • status - A comma separated list of statuses to filter the results.
  • from - a date string to set as the "from" marker. (mm/dd/yyyy format)
  • to - a date string to set as the "to" marker. (mm/dd/yyyy format)
  • records - a maximum number of results to get.

Returns: A list of Task Instance Objects.

get_task_log

Gets the run log for a Task Instance.

Required Arguments:

  • instance - The Task Instance identifier.

Returns: A Task Log Object.

get_task_parameters

Gets a Parameters template for a Task.

Required Arguments:

  • task - Value can be either a Task ID, Code or Name.

Optional Arguments:

  • version - A specific version. ('Default' if omitted.)
  • basic - in JSON mode, if provided, will omit descriptive details.

Returns: An XML template defining the Parameters for a Task.

This function is not affected by the output_format option. The Response is always an XML document.

get_task_plans

Gets a list of the queued execution plans for a Task.

Required Arguments:

  • task - Value can be either a Task ID or Name.

Optional Arguments:

  • version - A specific version. ('Default' if omitted.)

Returns: A list of Execution Plan Objects.

get_task_schedules

Gets a list of Schedule definitions for a Task.

Required Arguments:

  • task - Value can be either a Task ID or Name.

Optional Arguments:

  • version - A specific version. ('Default' if omitted.)

Returns: A list of Task Schedule Objects.

  • Text results do not include timing details.
  • JSON results include Schedule definitions suitable for use in the 'schedule_task' function.

import_backup

Imports an XML or JSON backup file.

Required Arguments:

  • import_text - An XML or JSON document in the format of a Task backup file.

Returns: A list of items in the backup file, with the success/failure of each import.

list_assets

Lists all Assets.

Optional Arguments:

  • filter - will filter a value match on: (Multiple filter arguments can be provided, delimited by spaces.)

    • Asset Name
    • Port
    • Address
    • DB Name
    • Status
    • Credential Username

Returns: A list of Asset Objects.

list_cloud_accounts

Lists all Cloud Accounts.

Optional Arguments:

  • filter - will filter a value match on: (Multiple filter arguments can be provided, delimited by spaces.)

    • Account Name
    • Account Number
    • Provider
    • Login ID
    • Default Cloud Name

Returns: A list of Cloud Account Object.

list_cloud_keypairs

Lists all the Key Pairs defined on a Cloud.

Required Arguments:

  • cloud - Name or ID of a Cloud.

Returns: A list of Cloud KeyPair Objects.

list_clouds

Lists all Clouds.

Optional Arguments:

  • filter - will filter a value match on: (Multiple filter arguments can be provided, delimited by spaces.)

    • Cloud Name
    • Provider
    • Default Account Name
    • API URL

Returns: A list of Cloud Objects.

list_credentials

Lists all Shared Credentials.

Optional Arguments:

  • filter - will filter a value match in Credential Name, Username, Domain or Description. (Multiple filter arguments can be provided, delimited by spaces.)

Returns: A list of Credential Objects.

list_document_collections

Lists all Datastore Document Collections.

Optional Arguments:

  • filter - will filter results on the Collection name. (A string to match in the Collection name.)

Returns: A list of Document Collections.

list_documents

Lists all Datastore Documents.

Optional Arguments:

  • collection - a document collection. 'Default' if omitted.
  • filter - will filter a value match in the Document ID or data. (Filter is a JSON object formatted as a Mongo query.)

Returns: A list of Datastore Document Objects.

list_tasks

Lists all Tasks.

Only 'Default' versions are shown.

Optional Arguments:

  • filter - will filter a value match in Task Name, Code or Description. (Multiple filter arguments can be provided, delimited by spaces.)
  • show_all_versions - if provided, will display all versions. ('False' if omitted.)

Returns: A list of Task Objects.

The Task Objects returned to this function are streamlined - they do not contain all the properties available in the get_task endpoint.

resubmit_task_instance

Resubmits an Errored or Cancelled Task Instance. Resubmit is only valid on Errored or Cancelled Task Instances.

Required Arguments:

  • instance - The Task Instance identifier.

Returns: Returns: Nothing if successful, error messages on failure.

run_task

Runs a Task.

Required Arguments:

  • task - Either the Task ID or Name.
  • version - The Task Version. (Unnecessary if 'task' is an ID.)

Optional Arguments:

  • data - A JSON document defining the intial Runtime Variable environment for this Task.
  • log_level - an integer (0-4) where 0 is none, 2 is normal and 4 is verbose. Default is 2.
  • account - the ID or Name of a Cloud Account. Certain Task commands require a Cloud Account.
  • parameters - A JSON or XML document defining parameters for the Task.
  • options - a JSON object defining certain options for this Task. Typically used to provide scope for extensions to the Task Engine.
  • run_later - if provided, the Task will be scheduled to run at the specified date/time. ex. "7/4/1776 15:30"

Returns: A Task Instance Object.

  • If 'output_format' is set to 'text', returns only a Task Instance ID.
  • If 'run_later' was specified, will return a success or error message.

schedule_tasks

Schedules one or more Tasks.

Required Arguments:

  • tasks - a JSON document containing a list of Tasks and schedule details.

Schedule definition format:

All lists are zero based integers. The Task Schedule Object response from the get_task_schedules command in JSON format can provide schedule definition examples for this command.

[
    { 
        "Task" : *task name*,
        "Version" : *optional*,
        "Months": "*" or [list of months],
        "DaysOrWeekdays": "Days" = days of the month, "Weekdays" = days of the week (default),
        "Days": "*" or [list of days],
        "Hours": "*" or [list of hours],
        "Minutes": "*" or [list of minutes]
    },
    {
        ...
    }
]

Returns: Nothing if successful, error messages on failure.

set_document_value

Sets the value of a key in a Datastore document.

Required Arguments:

  • query - A query in JSON format to select the correct Document.
  • lookupkey - The section of the document to retrieve.

Optional Arguments:

  • collection - a document collection. 'Default' if omitted.
  • value - The value to set this item. Item will be cleared if omitted.

Returns: A success message, or error messages on failure.

set_document_values

Sets multiple values in a Datastore document.

Required Arguments:

  • query - A query in JSON format to select the correct Document.
  • updatedoc - A document representing path:value pairs to be updated.

Optional Arguments:

  • collection - a document collection. 'Default' if omitted.

Multiple keys are updated in a looping manner. Unsuccessful updates will return an error, but will not stop subsequent updates from occuring.

Returns: A success message, or error messages on failure.

stop_task

Stops a running Task Instance.

Required Arguments:

  • instance - The Task Instance identifier.

Returns: Nothing if successful, error messages on failure.

update_cloud

Updates a Cloud.

Required Arguments:

  • name - Name or ID of the Cloud to update.

Optional Arguments:

  • apiurl - URL of the Cloud API endpoint.
  • apiprotocol - Cloud API endpoint protocol.
  • default_account - the name of a default Account for this Cloud.

Returns: The updated Cloud Object.

winrm_command

Test connectivity or issue Windows Remote Management commands on a defined Asset.

Required Arguments:

  • asset - Asset ID or Name of an Asset to use for the connection.

OR

  • server - WinRM Server FQDN or IP address.
  • user - User account.
  • password - User password.

Optional Arguments:

  • kerberos - Use Kerberos authentication if 'True', basic authentication if omitted.
  • command - The command to execute. (Will connection test only if omitted.)
  • powershell - (boolean) If True, will execute the command as a PowerShell command.

Returns: The result of the command, or errors.

Deploy

add_deployment

Create a new Application directly, without a template.

Required Arguments:

  • name - a name for the new Application.

Optional Arguments:

  • description - a description for the Application.

Returns: A Deployment Object.

add_sequence

Add a new Deployment Sequence.

Required Arguments:

  • deployment - a Deployment ID or Name.
  • sequence - a JSON Sequence definition.

Returns: A Deployment Sequence Object.

add_service

Add a new Service to a Deployment.

Required Arguments:

  • deployment - a Deployment ID or Name.
  • name - a Service Name.

Optional Arguments:

  • service - a Service definition document in JSON format.

Example Service definition JSON

{
    "Description": "",
    "Data": {},
    "Options": {}
}

Returns: A Deployment Service Object.

add_service_instance

Add a new Service Instance to a Deployment.

Required Arguments:

  • deployment - a Deployment ID or Name.
  • service - a Service ID or Name.
  • name - Name (label) of the new Service Instance.

Optional Arguments:

  • hostname - A name for a real host associated with this Instance.
  • address - IP Address of the host, required if host_name is provided.

Returns: A Deployment Service Instance Object.

copy_application_template

Copies an Application Template.

Required Arguments:

  • template - the name of an Application Template.
  • version - the Template version.
  • newname - a name for the new Template.
  • newversion - a version for the new Template

Returns: An Application Template Object.

create_application_template

Create a new Application Template.

Required Arguments:

  • name - A name for the Application Template.
  • version - The Template version
  • template - A JSON document formatted as an Application definition.

Optional Arguments:

  • description - Describe this Application Template.
  • icon - a Base64 encoded image file. (Suitable images are 32x32px in png, gif or jpg format.)
  • makeavailable - Immediately make the Application Template available for deployment.

Returns: An Application Template Object.

delete_application_template

Delete an existing Application Template.

You CANNOT delete a template if there are any Deployments created from it.

Required Arguments:

  • template - the name of a defined Application Template.
  • version - the Application Template version.

Optional Arguments:

  • deletetasks - will forcibly delete any Tasks directly referenced by this Template.

deletetasks will not delete indirectly referenced Tasks, such at those included in 'Subtask' and 'Run Task' commands.

Returns: Success or failure messages.

delete_deployment

Delete an existing Deployment Step.

Required Arguments:

  • deployment - a Deployment ID or Name.

Returns: Nothing if successful, or an error message.

delete_sequence

Delete an existing Deployment Sequence.

Required Arguments:

  • deployment - a Deployment ID or Name.
  • sequence - The name of a Sequence on this Deployment.

Returns: A list of remaining Deployment Sequence Objects.

deploy_application

Deploy an Application Template.

Required Arguments:

  • template - the name of a defined Application Template.
  • version - the Application Template version

Optional Arguments:

  • name - a name for the new Deployment. Will be automatically set if omitted.
  • description - a description for the Deployment. Will use the Description property of the Template if omitted.

Returns: A Deployment Object.

describe_deployment

Gets a complete Deployment object, including all Services and Steps.

Required Arguments:

  • deployment - a Deployment ID or Name.

Returns: A Deployment Object.

export_application_template

Generates an export JSON document containing everything in an Application Template.

This function will not export any items from the Canvas "filesystem" repository. That repository is controlled by the system administrator, and the definitions there are not portable.

Required Arguments:

  • template - the name of a defined Application Template.
  • version - the Application Template version.

Returns: An backup JSON bundle consisting of an Application Template Object, multiple Task Objects, and multiple Canvas Projects.

export_deployment

Reverse engineer a Deployment object into an Application Template.

Required Arguments:

  • deployment - a Deployment ID or Name.

Optional Arguments:

  • new_version - if provided, will save the generated Application Template as a new version of the source template of this Deployment.
  • makeavailable - immediately make the new version of the Application Template available for deployment.

Returns: An Application Template Object.

get_action_instances

Gets a list of Action Instances.

Required Arguments:

  • deployment - a Deployment ID or Name.

Optional Arguments:

  • service - a Service ID or Name.
  • instance - can be either a Service Instance ID or Name.
  • action - can be either an Action ID or Name.
  • filter - A filter to limit the results. (Multiple filter arguments can be provided, delimited by spaces.)
  • status - A comma separated list of statuses to filter the results.
  • from - a date string to set as the "from" marker. (mm/dd/yyyy format)
  • to - a date string to set as the "to" marker. (mm/dd/yyyy format)
  • records - a maximum number of results to get.

Returns: A list of Action Instance Objects.

get_action_parameters

Gets the Parameters template for a specific Deployment/Service Action.

Required Arguments:

  • deployment - a Deployment ID or Name.
  • action - The name of an Action on this Deployment.

Optional Arguments:

  • service - a Service ID or Name.

Returns: A Parameters document template.

get_application_template

Gets an Application Template object.

Required Arguments:

  • template - the name of a defined Application Template.
  • version - the Application Template version.

Optional Arguments:

  • getdefinition - will only return the JSON definition file.
  • geticon - will only return the Base64 encoded icon.

The 'get' options are exclusive. You cannot get both in a single call.

Returns: An Application Template Object.

get_deployment

Gets a Deployment object.

Required Arguments:

  • deployment - a Deployment ID or Name.

Returns: A Deployment Object.

get_deployment_document

Gets the Datastore document for a Deployment.

Required Arguments:

  • deployment - a Deployment ID or Name.

Returns: A Datastore Document Object.

get_deployment_log

Gets a Deployment log. If all arguments are omitted, will return the most recent 100 entries.

Required Arguments:

  • deployment - a Deployment ID or Name.

Optional Arguments:

  • filter - A filter to limit the results.
  • from - a date string to set as the "from" marker. (mm/dd/yyyy format)
  • to - a date string to set as the "to" marker. (mm/dd/yyyy format)
  • records - a maximum number of results to get.

Returns: A JSON array of log entries.

get_deployment_sequence

Gets a specific Sequence from a Deployment.

Required Arguments:

  • deployment - a Deployment ID or Name.
  • sequence - The name of a Sequence on this Deployment.

Returns: A Deployment Sequence Object.

get_deployment_sequences

Gets all Sequences from a Deployment.

Required Arguments:

  • deployment - a Deployment ID or Name.

Optional Arguments:

  • filter - will filter a value match on Sequence Name. (Multiple filter arguments can be provided, delimited by spaces.)

Returns: A list of Deployment Sequence Objects.

get_deployment_services

Gets the Services for a Deployment. In JSON or XML output format, will return all details including the Service Datastore document.

Required Arguments:

  • deployment - a Deployment ID or Name.

Optional Arguments:

  • filter - will filter a value match on Service Name. (Multiple filter arguments can be provided, delimited by spaces.)

Returns: A list of Deployment Service Objects.

get_license

Get the license details.

Required Arguments:

  • license - The text of a license key provided by Continuum.

Returns: The relevant properties of the current license.

get_maestro_url

Gets a URL suitable for directing a user from an external application to a specific page in the deploy UI.

Some optional arguments will be required, depending on the value for 'page'.

Required Arguments:

  • page - the name of a detail page in deploy. Valid values are:
    • deployment
    • service
    • service_instance
    • sequence_status
    • task_instance

Optional Arguments:

  • user - a User ID or Name. If omitted, the authenticated API user will be used.
  • deployment - a Deployment ID or Name.
  • service - a Service ID or Name.
  • service_instance - can be either a Service Instance ID or Name.
  • sequence_instance - a Sequence Instance ID.
  • task_instance - a Task Instance ID (For a Sequence Step, Action or Monitor).

Returns: A deploy UI URL with an authentication token.

get_monitor_instances

Gets a list of Monitor Instances.

Required Arguments:

  • deployment - a Deployment ID or Name.

Optional Arguments:

  • service - a Service ID or Name.
  • instance - can be either a Service Instance ID or Name.
  • filter - A filter to limit the results. (Multiple filter arguments can be provided, delimited by spaces.)
  • status - A comma separated list of statuses to filter the results.
  • from - a date string to set as the "from" marker. (mm/dd/yyyy format)
  • to - a date string to set as the "to" marker. (mm/dd/yyyy format)
  • records - a maximum number of results to get.

Returns: A list of Monitor Instance Objects.

get_sequence_instance

Gets a Sequence Instance.

Required Arguments:

  • instance - the Sequence Instance ID.

Returns: A Sequence Instance Object.

get_sequence_instance_status

Gets a Sequence Instance Status.

Required Arguments:

  • instance - the Sequence Instance ID.

Returns: The status of a Sequence Instance.

get_sequence_instances

Gets a list of Sequence Instances.

Required Arguments:

  • deployment - a Deployment ID or Name.

Optional Arguments:

  • filter - A filter to limit the results. (Multiple filter arguments can be provided, delimited by spaces.)
  • status - A comma separated list of statuses to filter the results.
  • from - a date string to set as the "from" marker. (mm/dd/yyyy format)
  • to - a date string to set as the "to" marker. (mm/dd/yyyy format)
  • records - a maximum number of results to get.

Returns: A list of Sequence Instance Objects.

get_sequence_parameters

Gets the parameters template for a Sequence.

Required Arguments:

  • sequence - The name of a Sequence on this Deployment.

Optional Arguments:

Either the deployment parameter or template name and version are required.

  • deployment - a Deployment ID or Name.
  • template - an Application Template Name
  • version - an Application Template Version
  • basic - if 'true' the result will contain no extra names, default values or descriptive details.

Returns: A JSON parameters template.

get_service_document

Gets the Datastore document for a Service.

Required Arguments:

  • deployment - a Deployment ID or Name.
  • service - a Service ID or Name.

Returns: A Datastore Document Object.

get_service_instance_document

Gets the Datastore document for a Service Instance.

Required Arguments:

  • deployment - a Deployment ID or Name.
  • instance -a Service Instance ID or Name.

Returns: A Datastore Document Object.

get_service_instances

Gets Service Instances from a Deployment Service.

Required Arguments:

  • deployment - a Deployment ID or Name.

Optional Arguments

  • service - a Service ID or Name.

Returns: A list of Services containing a list of Deployment Service Instance Objects.

install_license

Installs a license file.

Required Arguments:

  • license - The text of a license key provided by Continuum.

Returns: Success or Error message.

list_application_templates

Lists all Application Templates.

Optional Arguments:

  • filter - will filter a value match on Template Name, Version or Description. (Multiple filter arguments can be provided, delimited by spaces.)

Returns: A list of Application Template Objects.

list_deployments

Lists all Deployed Applications.

Optional Arguments:

  • filter - will filter a value match on any of the following fields: (Multiple filter arguments can be provided, delimited by spaces.)
    • Deployment Name
    • AutomationStatus
    • RunState
    • Health
    • Owner
  • from - limit to Deployments created after the specified date. (mm/dd/yyyy format)
  • to - limit to Deployments created before the specified date. (mm/dd/yyyy format)

Returns: A list of Deployment Objects.

list_template_tasks

Lists all Tasks associated with an Application Template.

Required Arguments:

  • template - the name of a defined Application Template.
  • version - the Application Template version.

Returns: An list of Task Objects. associated with the Application Template.

remove_service_from_sequence_step

Remove a Service from a Deployment Sequence Step.

Required Arguments:

  • deployment - a Deployment ID or Name.
  • sequence - The name of a Sequence on this Deployment.
  • step - The Step number.
  • service - a Service ID or Name.

Returns: A Deployment Sequence Object.

remove_service_instance

Remove a Service Instance from a Deployment Service.

Required Arguments:

  • deployment - a Deployment ID or Name.
  • instance - can be either a Service Instance ID or Name.

Returns: Success or Error message.

resubmit_sequence

Resubmit a halted Sequence Instance.

Required Arguments: instance The Sequence Instance identifier.

Returns: Nothing if successful, error messages on failure.

run_action

Runs an Action on a Deployment, Service or Service Instance.

Required Arguments:

  • deployment - a Deployment ID or Name.
  • action - The name of an Action on this Deployment.

Optional Arguments:

  • service - a Service ID or Name.
  • service_instance - can be either a Service Instance ID or Name.
  • log_level - an integer (0-4) where 0 is none, 2 is normal and 4 is verbose. Default is 2.
  • params - a JSON document of properly formatted parameters for this sequence run.

Returns: A Task Instance Object.

run_sequence

Starts a Sequence on a Deployment.

Required Arguments:

  • deployment - a Deployment ID or Name.
  • sequence - The name of a Sequence on this Deployment.

Optional Arguments:

  • onerror - how to react if errors are encountered. 'halt' or 'pause'. 'pause' if omitted.
  • params - a JSON document of properly formatted parameters for this sequence run.

Returns: A Sequence Instance Object.

PARAMETERS A Sequence is a complex definition, containing multiple Steps and many Services on each Step.

Parameters can be defined for the entire Sequence (available in any Task). Also, each Service on a Step is a pointer to a Task, which may accept it's own parameters.

Each parameter is an object, with a "name" and "values". "name" is a string - the name of the parameter. "values" is a list - a list of values for the parameter specified by "name".

A properly formatted 'params' argument will be similar to the following:

{
    "DeploymentParamsVals": [
    {
        "name": "param_one",
        "values": ["value_one"]
    }
],
    "SequenceParamsVals": [],
    "Services": [
        {
            "ServiceName": "App Server",
            "Transitions": [
                {
                    "Parameters": [],
                    "Step": 1
                }
            ]
        },
        {
            "ServiceName": "Database",
            "Transitions": [
                {
                    "Parameters": [],
                    "Step": 1
                },
                {
                    "Parameters": [],
                    "Step": 2
                }
            ]
        }
    ]
}

stop_sequence

Stops a running Sequence Instance.

Required Arguments: instance The Sequence Instance identifier.

Returns: Nothing if successful, error messages on failure.

Flow

associate_commits_to_v1_workitem

    Required Arguments:

    * `commit_shas` - a list of all the changes to associate to a workitem.
    * `associated_by` - user that made the association in VersionOne
    * `workitem_number` - workitem number from VersionOne.
    * `instance_url` - VersionOne instance url1.

cancel_pipelineinstance

Cancel a running Pipeline Instance.

All Pending or Processing statuses will be set to Canceled.

Required Arguments:

  • pi - The Name or ID of a Pipeline Instance.

Returns: 'true' on success, errors on failure.

configure_plugins

Configures a Flow Plugin.

WARNING: at this time, any plugins in the input JSON will be OVERWRITTEN!

USE WITH CAUTION.

Required Arguments:

  • plugins - A list of JSON objects, each formatted as a valid Plugin config.

Returns: success or error.

copy_project

Copy a Project.

Required Arguments:

  • project - the id or name of a Project.
  • newname - a name for the new Project.

Returns: 'true' on success, errors on failure.

create_pipeline

Create a Pipeline Definition.

Required Arguments:

  • template - A JSON document formatted as a CSK Pipeline Definition.

Returns: A Pipeline Definition Object.

create_project

Create a Project.

Required Arguments:

  • name - Name of the Project.

Returns: A Project Object.

delete_pipeline

Permanently delete a Pipeline Definition.

Required Arguments:

  • pipeline - the id or name of a Pipeline Definition.

Returns: 'true' on success, errors on failure.

delete_pipelinegroup

Permanently delete a Pipeline Instance Group.

Required Arguments:

  • pg - The ID of a Pipeline Instance Group.

Returns: 'true' on success, errors on failure.

delete_pipelineinstance

Permanently delete a Pipeline Instance.

Required Arguments:

  • pi - The Name or ID of a Pipeline Instance.

Returns: 'true' on success, errors on failure.

delete_project

Permanently delete a Project.

Required Arguments:

  • project - the id or name of a Project.

Returns: 'true' on success, errors on failure.

export_flow

Export the complete Flow definition catalog as a portable backup JSON document.

Returns: A JSON backup document.

export_pipeline

Export a Pipeline Definition as a portable backup JSON document.

Required Arguments:

  • pipeline - the id or name of a Pipeline Definition.

Returns: A Pipeline Definition Object.

export_project

Gets a Project object for export. (Will not include the _id.)

Required Arguments:

  • project - the id or name of a Project.

Returns: A Project Object.

get_next_id

get_pi_artifacts

Gets the Changes from the Manifest of a Pipeline Instance.

Required Arguments:

  • pi - the id or name of a Pipeline Instance.

Returns: A JSON document representing all Changes on the Manifest.

Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.

get_pi_changes

Gets the Changes from the Manifest of a Pipeline Instance.

Required Arguments:

  • pi - the id or name of a Pipeline Instance.

Returns: A JSON document representing all Changes on the Manifest.

Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.

get_pi_data

Gets a Pipeline Instance Data object.

Required Arguments:

  • pi - the id or name of a Pipeline Instance.

Optional Arguments:

  • lookup - Lookup using an expression that evaluates to a subsection of the document.

Returns: A Pipeline Instance.

Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.

get_pi_workitems

Gets the Workitems from the Manifest of a Pipeline Instance.

Required Arguments:

  • pi - the id or name of a Pipeline Instance.

Returns: A JSON document representing all Workitems on the Manifest.

Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.

get_pipeline

Gets a Pipeline Definition object.

Required Arguments:

  • pipeline - the id or name of a Pipeline Definition.

Returns: A Pipeline Definition Object.

get_pipelineinstance

Gets a Pipeline Instance object.

Required Arguments:

  • pi - the id or name of a Pipeline Instance.

Optional Arguments:

  • include_stages - include Stage, Step and Plugin data and status.

Returns: A Pipeline Instance.

get_project

Gets a Project object.

Required Arguments:

  • project - the id or name of a Project.

Returns: A Project Object.

get_registry

Gets a registry document by name.

Required Arguments:

  • name - Name of the Registry document.

Returns: the entire Registry document on success, 'not found' otherwise.

get_submission

Gets a raw 'Submission' payload using a query.

Required Arguments:

  • query - Valid MongoDB query to identify the previous payload to resubmit.

 

If the query would return multiple submissions, the newest one is matched.

Returns: the Submission document on success, 'not found' otherwise.

get_worklist

Gets a list of Pipeline in 'pending' status.

Optional Arguments:

  • filter - a key:value filter to limit the results.

Returns: A list of pending Pipeline Instances.

import_flow

Import a complete Flow backup.

Required Arguments:

  • backup - A JSON document formatted as a complete Flow backup.

Optional Arguments:

  • overwrite - Valid values: pipelines|phases|all|none (default).

    If 'overwrite' is 'all', all existing Pipeline Definitions, Phases and Stages will be replaced. If 'overwrite' is 'none' (default), any existing Pipeline Definitions, Phases and Stages will be left unchanged.

Returns: Success or error.

import_pipeline

Import a Pipeline Definition.

Required Arguments:

  • backup - A JSON document formatted as a complete Continuum Pipeline Definition backup.

Optional Arguments:

  • overwrite - Valid values: true|false (default).

    If 'overwrite' is 'true' and the Definition exists, it will be replaced.

Returns: A Pipeline Definition Object.

import_project

Import a Project.

Required Arguments:

  • backup - A JSON document formatted as a complete Project backup.

Optional Arguments:

  • overwrite - Valid values: pipeline|phases|all|none (default).

    If 'overwrite' is 'true' the Project will be replaced.

Returns: A Project Object.

initiate_pipeline

Attempt to initiate a Pipeline Definition.

Required Arguments:

  • definition - ID or Name of a Pipeline Definition to initiate.
  • project - An identifying name for a Project. (ie: repo name) Useful if a single pipeline definition supports multiple projects.
  • group - Summary name, (ie: branch name) used to group all runs of this definition/project combination. Describes your 'use' of this Pipeline.

Optional Arguments:

  • instance_name - An explicit name to use for this unique run. (ie: commit id)
  • details - a JSON object with additional properties for the Pipeline Instance, often required by specific plugins.

Returns: A Pipeline Instance Object.

invoke_plugin

Invoke a Plugin Function.

Required Arguments:

  • plugin - the name of the Plugin PLUS the Module. (ex: github.main)
  • method - the method to invoke. (ex "get_issue")

Optional Arguments:

  • args - a JSON formatted string of arguments which will be sent to the Plugin Function.

Returns: Response varies depending on the Plugin Function called.

list_pipelinegroups

Lists all Pipeline Instance Groups (Stories).

Optional Arguments:

  • pipeline - will limit the results a specific Pipeline Definition.
  • project - will limit the results a specific 'project'.
  • group - will limit the results to a specific 'group'.

Returns: A list of Pipeline Instance Group Objects.

list_pipelineinstances

Lists all Pipeline Instances.

Optional Arguments:

  • definition - will limit the results a specific Pipeline Definition.
  • project - will limit the results to a specific 'project'.
  • group - will limit the results to a specific 'group'.

Returns: A list of Pipeline Instance Objects.

list_pipelines

Lists all Pipeline Definitions.

Optional Arguments:

  • filter - will filter a value match on any of the following fields: (Multiple filter arguments can be provided, delimited by spaces.)
    • Definition Name
    • Status

Returns: A list of Pipeline Definition Objects.

list_projects

Lists all Projects.

Optional Arguments:

Returns: A list of Project Objects.

post_pi_data

Post data to the Workspace on a running Pipeline Instance.

Required Arguments:

  • pi - the id or name of a Pipeline Instance.
  • key - key to set in the Workspace data.
  • value - value for the provided key.

All data is posted under a parent key - 'returns', to protect the overall Workspace.

Returns: 'true' on success, errors on failure.

Example using curl using a variable for the pipeline instance id and posting an array of values:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Token 5752fb9abb288013973fabf4" -d "{\"pi\": \"$PI_ID\", \"key\":\"hello\", \"value\": [\"world2\", \"earth\", \"mars\"]}" "http://continuum-server.example.com:8080/api/post_pi_data"

promote_revision

Promotes a Package Revision to a particular Phase

Required Arguments:

  • package - Name of the Package to promote to a progression Phase
  • revision - Revision number of a Package to promote
  • full_version - Full Version of package to promote, optional, if revision is provided it is used
  • phase - Name of the Phase to promote the Pacakge Revision to

Optional Arguments:

Returns: success on success, errors otherwise.

register_plugin

Register a new Flow Plugin.

Required Arguments:

  • name - Name of the new plugin.

Returns: success or error.

resubmit_change

Resubmits a change 'Submission' payload to the specified Project.

Required Arguments:

  • query - Valid MongoDB query to identify the previous payload to resubmit.

 

 

If the query would return multiple submissions, the newest one is matched.

Returns: 'true' on success, errors on failure.

retry_pipelineinstance

Attempt to retry a failed Pipeline Instance. Simply restarts it again at Phase One.

CAUTION: The Workspace data is not cleared or reset. Depending on the design of the Pipeline, this may not succeed, or might produce unexpected results.

Required Arguments:

  • pi - The Name or ID of a Pipeline Instance.

Returns: A Pipeline Instance Object.

run_metric

Runs a specific metric.

Required Arguments:

  • module - Name of the metrics module that contains the metric function to run
  • metric - Name of a function definition in the specified module

Optional Arguments:

  • args - a JSON object of arguments the target metric may require

Returns: success on success, errors otherwise.

set_pi_data

Set Workspace data on a running Pipeline Instance.

Required Arguments:

  • pi - the id or name of a Pipeline Instance.
  • key - key to set in the Workspace data. (Certain internal keys are restricted and cannot be overridden.)
  • value - value for the provided key.

NOTE: USE WITH CAUTION! This function has the ability to overwrite values anywhere in the Workspace. For safer and more common cases, use 'postpidata'.

Returns: 'true' on success, errors on failure.

Example using curl:

curl http://continuum-server.example.com:8080/api/set_pi_data?token=5752fb9abb288013973fabf4&key=hello&value=world&pi=57acb49a320c7a41bf32958a

set_pi_description

Set pipeline instance description

Required Arguments:

  • pi - the id or name of a pipeline instance
  • description - Description of the instance (HTML allowed)

Returns: 'true' on success, errors on failure.

set_pi_global_summary

Set global summary data on a pipeline instance

Required Arguments:

  • pi - the id or name of a pipeline instance
  • key - key to set in the global summary
  • value - value for the provided key

Returns: 'true' on success, errors on failure.

Example using curl:

curl http://continuum-server.example.com:8080/api/set_pi_data?token=5752fb9abb288013973fabf4&key=hello&value=world&pi=57acb49a320c7a41bf32958a

set_pipelinegroup_number

Set the autonumber root on Pipeline Instance Group. (Used to issue ascending numbers to Instances in the Group.)

Required Arguments:

  • pg - The ID of a Pipeline Instance Group.
  • newnumber - The new number to set as the autonumber root.

Returns: 'true' on success, errors on failure.

set_registry

Sets values in a specific Registry document.

Required Arguments:

  • name - Name of the Registry document.
  • path - Will place value at this path.

Optional Arguments:

  • value - Value to set at specified path, or entire document. If omitted, target key or document will be cleared.
  • action - Valid values: set | unset | addtoset | push | pull (Mongo operators)
  • create - Create named Registry if it doesn't exist? Valid values: true | false

Returns: success on success, errors otherwise.

submit_change

Submits a change payload to the specified Project.

Required Arguments:

  • toproject - the ID or Name of a Project.

 

NOTE: This API is different than most others. It's expecting a JSON document as HTTP POST data. The required toproject argument can either be provided inside the POST data, or on the URL querystring.

Returns: 'true' on success, errors on failure.

test_plugin_connection

Tests connectivity to a Plugin instance defined in the Continuum configuration.

Required Arguments:

  • plugin - the module name of a Plugin.

Optional Arguments:

  • instance - A named Plugin instance in the Continuum configuration. If not used, the default instance will be tested.

Returns: A success message or error message

Admin

accept_webhook

Accepts any JSON payload submitted, and runs it through the defined list of Directives.

Required Arguments:

  • handler - name of a defined 'Webhook Handler' containing directives to apply to this payload.

Returns: Success message if successful, error message on failure.

add_object_tag

Adds a security Tag to an object.

Required Arguments:

  • tag - The name of the Tag.
  • object_id - The ID of the object.
  • object_type - The numeric type of the object.

Returns: Success message successful, error message on failure.

Valid and currently implemented object_type values are:

  • User = 1
  • Asset = 2
  • Task = 3
  • Canvas Item = 50
  • Deployment = 70
  • Application Template = 71

create_canvas_item

Creates a new Canvas item.

If the 'repository' options is set to 'file', only an Administrator can make this call.

Required Arguments:

  • project - a Canvas Project name.
  • component - a Canvas Component name.
  • name - a Canvas item name.
  • data - the content of the item.

Optional Arguments:

  • repository - if 'file', will save the report in the Filesystem repository.
  • ignoreconflicts - if 'true' existing items will be overwritten.

Returns: Success or Error message.

create_tag

Creates a new security Tag.

Required Arguments:

  • name - The name of the new Tag. (AlphaNumeric ONLY. Cannot contain spaces, punctuation or special characters.)

Optional Arguments:

  • description - Describe the Tag.

Returns: The new Tag Object if successful, error message on failure.

create_user

Creates a new user account.

Only an 'Administrator' can create other users. If the credentials used for this API call are not an Administrator, the call will not succeed.

Required Arguments:

  • user - A login name for the user.
  • name - The full name of the user.
  • role - The users role. Valid values:

    • Administrator
    • Developer
    • User

Optional Arguments:

  • password - Password for the user. If password is not provided, a random password will be generated.
  • email - Email address for the user. Required if 'password' is omitted.
  • authtype - 'local' or 'ldap'. Default is 'local' if omitted.
  • forcechange - Require user to change password. Default is 'true' if omitted. (Valid values: 'true' or 'false')
  • status - Status of the new account. Default is 'enabled' if omitted. (Valid values: enabled, disabled, locked)
  • expires - Expiration date for this account. Default is 'never expires'. Must be in mm/dd/yyyy format.
  • groups - A list of groups the user belongs to. Group names cannot contain spaces. Comma delimited list.
  • get_token - If true, will return an automatic login token. (Valid values: 1, yes, true)
  • contributors - A list of contributors the user is mapped to. Contributors cannot contain spaces. Comma delimited list.

Returns: A User Object.

delete_tag

Deletes a security Tag.

Required Arguments:

  • name - The name of the Tag.

Returns: Success message if successful, error message on failure.

export_canvas

Generates an export JSON document all Canvas items.

This function is capable of exporting items from the "filesystem" repository, which is an administrative feature.

Optional Arguments:

  • project - filter by a Canvas Project name.
  • component - filter by a Canvas Component. (Project is required.)
  • repository - specify the repository ('file' or 'db', 'db' if omitted.)

Returns: A JSON document containing Canvas items.

get_settings

Lists all the settings of modules.

Optional Arguments:

  • module - name of the module. If omitted, all module settings are returned.

Returns: A Settings Object.

get_system_log

Gets the system log. If all arguments are omitted, will return the most recent 100 entries.

Optional Arguments:

  • object_id - An object_id filter to limit the results.
  • object_type - An object_type filter to limit the results.
  • log_type - A log_type filter. ('Security' or 'Object')
  • action - An action filter.
  • filter - A filter to limit the results.
  • from - a date string to set as the "from" marker. (mm/dd/yyyy format)
  • to - a date string to set as the "to" marker. (mm/dd/yyyy format)
  • records - a maximum number of results to get.

Returns: A list of Log Entry Objects.

get_token

Gets an authentication token for the API, which is the preferred alternative to 'Basic' authorization.

This function requires Basic authorization to be enabled.

Pass an Authorization header of type Basic to retrieve your Token.

If a token doesn't exist for the authenticated User, this method will generate a new token.

Returns: An authentication token.

import_backup

list_canvas_items

Returns a list of all elements in the Canvas feature.

Optional Arguments:

  • project - filter by a Canvas Project name.
  • component - filter by a Canvas Component. (Project is required.)
  • repository - specify the repository ('file' or 'db', 'db' if omitted.)

Returns: A list of all Canvas elements.

list_processes

Lists all running processes.

Returns: A list of Process Objects.

list_tags

Lists all Tags.

Optional Arguments:

  • filter - will filter a value match in Tag Name. (Multiple filter arguments can be provided, delimited by spaces.)

Returns: A list of Tag Objects.

list_users

Lists all registered Users.

Optional Arguments:

  • filter - will filter a value match on: (Multiple filter arguments can be provided, delimited by spaces.)

    • Full Name
    • Login ID
    • Role
    • Email address

Returns: A list of User Objects.

patch

If enabled, allows remote patching of a source or configuration file.

Required Arguments:

  • path - the path (in $CONTINUUM_HOME) of the file to be patched
  • content - the content which will replace the target file
  • authcode - the secure authorization code

Returns: Success message if successful, error message on failure.

remove_object_tag

Removes a security Tag from an object.

Required Arguments:

  • tag - The name of the Tag.
  • object_id - The ID of the object.
  • object_type - The numeric type of the object.

Returns: Success message if successful, error message on failure.

reset_password

Resets the password of the authenticated, or a specified User.

If a user is specified, and the authenticated user is an Administrator, this will reset the password of the specified user to the provided value.

If no user is specified, the password of the authenticated user will be changed.

NOTE: to prevent accidental change of an Administrators password, an extra trap is in place: * the username (or id) MUST be provided, even if the authenticated user is the user being changed.

Required Arguments:

  • password - the new password.
  • - OR -
  • generate - generate a random password.

Optional Arguments:

  • user - Either the User ID or Name.

Returns: Success message if successful, error messages on failure.

send_message

Sends a message to a registered user. Message will be 'From' the authenticated API user.

The 'to' argument accepts both email addresses AND Continuum Users. Each item in the 'to' list will try to look up a Continuum User, and if it doesn't match, will assume the entry is an email address.

Required Arguments:

  • to - a single or comma-separated list of valid email addresses or Continuum Users.
  • subject - a subject line
  • message - the message body

Optional Arguments:

  • cc - a carbon copy list of comma-separated email addresses or Continuum Users.
  • bcc - a blind carbon copy list of comma-separated email addresses or Continuum Users.

Returns: Success message if successful, error message on failure.

update_settings

Updates the settings of a process or module.

NOTE: the updatesettings command requires submission of a JSON settings object. As a guide for updating settings, first execute this command with the Accept: application/json header (or outputformat=json argument).

For example, to update Messenger settings, first do:

getsettings?module=messenger&outputformat=json

...then use the result as a template for update_settings.

Required Arguments:

  • module - name of the module to apply the settings.
  • settings - a list of name:value setting objects.

Returns: Nothing if successful, error messages on failure.

update_user

Updates a user account.

Only an 'Administrator' can manage other users. If the credentials used for this API call are not an Administrator, the call will not succeed.

Properties will only be updated if the option is provided. Omitted properties will not be changed.

NOTE: the "username" of a user cannot be changed.

If a user has 'locked' their account by numerous failed login attempts, the flag is reset by setting any property. It's easiest to just the status to 'enabled'.

Required Arguments:

  • user - ID or Name of the User to update.

Optional Arguments:

  • name - The full name of the user.
  • role - The users role. (Valid values: Administrator, Developer, User)
  • email - Email address for the user. Can be cleared with "None".
  • authtype - 'local' or 'ldap'.
  • forcechange - Require user to change password on next login. (Valid values: 'true' or 'false')
  • status - Status of the account. (Valid values: enabled, disabled, locked)
  • expires - Expiration date for this account. Must be in mm/dd/yyyy format. Can be cleared with "None".
  • groups - Add to the list of groups the user belongs to. Group names cannot contain spaces. Comma delimited list.

  • password - the new password.

  • - OR -
  • generate - generate a random password.

Returns: A User Object.

validate_instance

Validate a Continuum instance exists and the request is authenticated.

Returns: Success or Error message.

version

Returns: The Continuum version.

Metrics

The Continuum API is able to provide summary data for various objects. The desired summary can be obtained by passing a summary type and its arguments inside a context array. For example:

{
    "type": "pi_summary",
    "context": {
        "project": "mobile app",
        "pipeline": "deploy to staging",
        "group": "master"
    }
}

All summaries can be requested on this endpoint http://localhost:8080/api/metric using the following types:

pi_summary

Returns summary data for a Pipeline Instance

Required Arguments:

  • project
  • pipeline
  • group

pig_summary 

Returns summary data for a Pipeline Instance Group

Required Arguments:

  • project
  • pipeline
  • group

pipeline_summary

Returns summary data for a Pipeline

Required Arguments:

  • pipeline

project_summary

Returns summary data for a project

Required Arguments:

  • project

automate_summary

Returns summary data for all activities carried out by Continuum Automate 

Requires no arguments

daily_summary

Returns summary data for general Continuum activities across all sections.

Required Arguments:

  • date

deploy_summary

Returns summary data for all activities carried out by Continuum Deploy

Requires no arguments

package_summary

Returns summary data for a specific Continuum package. 

Required Arguments:

  • package
  • progression

package_version_summary

Returns summary data for a specific version or a particular package

Required Arguments:

  • package
  • progression
  • version
  • Was this article helpful?