Itential logo
API docs by Redocly

Platform 6 (1.0.0)

Download OpenAPI specification:

Platform 6 REST API for Application Integration.

About

The Itential REST API uses OpenAPI 3.1.0 specifications and supports Basic Authentication and OAuth 2.0 to authenticate requests. This reference library documents available APIs for the Platform 6, including HTTP response codes to indicate success or failure of an API request. Platform 6 REST APIs also use standard verbs to perform CRUD operations. For product documentation, visit Itential Documentation & Guides.

Ports and Base Path

Default HTTP port is 3000. Default HTTPS port is 3443. Both IPv6 and IPv4 are supported. Default host is 127.0.0.1. The basePath is /.

Authentication

API requests without authentication will fail. Available authorizations include: BasicAuth (username/password), CookieAuth(token/cookie-based) and QueryAuth (token/query-based).

Basic Auth

This API uses Basic Authentication for securing its endpoints.

How to Use Basic Authentication

Using this authentication strategy, you need to provide your credentials in the HTTP request headers. The credentials should be sent as a base64 encoded string of username:password.

Example: Using curl for Basic Authentication

curl -u username:password -X GET "https://localhost:3443"

In this example, -u is the flag used by curl to specify the username and password. Replace username and password with your actual credentials.

HTTP Request Headers

The Basic Authentication credentials are sent in the Authorization header. Here's what it looks like:

Authorization: Basic base64(username:password)

Base64 Encoding

The username:password string needs to be base64 encoded before it is sent in the header. For example, if your username is user and your password is pass, the string to encode is user:pass. The base64 encoded result would look something like this:

Authorization: Basic dXNlcjpwYXNz

Query Token

Authentication

Using this authentication strategy, you need to authenticate and obtain a token by making a POST request to the /login endpoint. The response token will be used in the token query parameter for subsequent requests.

How to Request a Token

To obtain an authentication token, send a POST request to the /login endpoint with the following JSON payload:

{ "user": { "username": "admin", "password": "admin" } }

Example: Using curl to Request a Token

curl -X POST "https://localhost:3443/login" -H "Content-Type: application/json" -d '{"user": {"username": "admin", "password": "admin"}}'

In this example, the -d flag is used by curl to send the JSON body with the request.

Response

If the login is successful, the API will return the authentication token. The token can be used in the token query parameter for subsequent requests:

your-auth-token-here

Using the Token in Subsequent Requests

Once you have the token, include it in the query string of your requests as follows:

?token=your-auth-token-here

Client Auth

Authentication

Using this authentication strategy, you need to authenticate and obtain a Bearer token by making a POST request to the /oauth/token endpoint. The response access_token will be used as temporary credentials that the client will set in the Authorization header. Here's what it looks like:

Authorization: Basic access_token

.

How to Request a Token

To obtain an authentication token, send a POST request to the /oauth/token endpoint. You'll need to send the data as application/x-www-form-urlencoded with the following payload:

client_id=your-client-id&client_secret=your-client-secret&grant_type=client_credentials

Example: Using curl to Request a Bearer Token

curl -X POST "https://localhost:3443/oauth/token" -H "Content-Type: accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d 'client_id=123abccc123a123a12ab1ab1&client_secret=a123a123-a1a1-1a1a-a123-123a12abc1a1&grant_type=client_credentials'

In this example, the -d flag is used by curl to send the data with the request.

Response

If the login is successful, the API will return the authentication token. The token can be used in the token query parameter for subsequent requests:

{ "access_token": "falksjflkasdjflkasdjfklajsdflj.eyJwcmluY2lwYWxJZCI6IjY2OWU1ZGNjOTE1ZDUxMWEzMmJmMGNhNCIsImV4cCI6MTcyMTY1OTQ4MDkwMiwiaWF0IjoxNzIxNjU1ODgwfQ.7jrB2mC9aqSdPdUvz7D-u9HghRFtnpFbYdaBH54kNZc","token_type": "bearer","expires_in": 3600}

Using the Bearer Token in Subsequent Requests

Once you have the Bearer token, use it as your Authorization header. Here's what it should look like:

Authorization: Bearer your-access_token-here

Example (whoami) - Basic Auth

To test the API using Basic Authentication, you can use the following curl command. Replace username and password with your actual credentials.

Note: Basic Auth is only available over SSL.

curl -u username:password -X GET "https://localhost:3443/whoami"

This command sends a GET request to the specified resource, using the provided username and password for authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.

Example (whoami) - Query Token

To test the API using the Query Token Authentication, you can use the following curl command. Replace your-auth-token-here with your actual token that you received using /login.

curl -X GET "https://localhost:3443/whoami?token=your-auth-token-here"

This command sends a GET request to the specified resource, using the Query Token authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.

Example (whoami) - Client Bearer Token

To test the API using the Client Authentication, you can use the following curl command. Replace your-access_token-here with your actual Bearer token that you received using /oauth/token.

curl -X GET "https://localhost:3443/whoami" -H "Authorization: Bearer your-access_token-here"

This command sends a GET request to the specified resource, using the Client authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.

Adapter Models

Get the list of available adapter model types.

Get the list of available adapter model types in the current IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
contains
string
Examples: contains=profile1

contains

equals
string
Examples: equals=profile1

equals

startsWith
string
Examples: startsWith=profile

startsWith

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

Responses

Response samples

Content type
application/json
{
  • "adapterModels": [
    ],
  • "total": 1
}

Adapters

Create a new adapter.

Create a new adapter in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Get all adapters.

Get all adapters in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
contains
string
Examples: contains=redis

contains

containsField
string
Examples: containsField=name

containsField

equals
string
Examples: equals=redis

equals

equalsField
string
Examples: equalsField=name

equalsField

startsWith
string
Examples: startsWith=redis

startsWith

startsWithField
string
Examples: startsWithField=name

startsWithField

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

skipActiveSync
boolean
Default: false

skipActiveSync

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": 1
}

Import a new adapter.

Import a new adapter in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Delete an adapter.

Delete an adapter from IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected adapter.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Get a single adapter.

Get a single adapter in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected adapter.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "data": {
    }
}

Update an adapter.

Update an adapter in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name for the selected adapter.

Request Body schema: application/json

request body

object (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Export a single adapter.

Export a single adapter in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected adapter.

Responses

Response samples

Content type
application/json
{
  • "type": "Application",
  • "properties": {
    },
  • "loggerProps": {
    },
  • "isEncrypted": true,
  • "profiling": true,
  • "model": "@itential/adapter-local_aaa",
  • "name": "Local AAA",
  • "virtual": true,
  • "systemProps": {
    },
  • "eventDeduplication": {
    }
}

Get the list of changelogs. Deprecated

Get the list of changelogs for a specific adapter.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: WorkFlowEngine MOP

The name of the selected adapter.

query Parameters
release
string
Examples: release=0.0.1 release=0.1.0 release=1.0.0 release=1.1.1-2020.1.0

release

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Start an adapter.

Start an adapter in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected adapter.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Stop an adapter.

Stop an adapter in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected adapter.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Restart an adapter.

Restart an adapter in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected adapter.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Update the log levels.

Update the log levels for an adapter.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name for the selected adapter.

Request Body schema: application/json

request body

object (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Update the properties of an adapter.

Update the properties of an adapter in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name for the selected adapter.

Request Body schema: application/json

request body

properties
any (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": null
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Get a mapping between brokers and adapters.

Get a mapping between brokers and adapters.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{
  • "aaa": [
    ]
}

Automation Gateway

Merge discovered actions from all IAG adapters

Discovers all actions from inputed IAG adapters. This will restart this app and display a corresponding log message.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

taskContinuation
boolean (Task Continuation)
Default: true

Responses

Request samples

Content type
application/json
{
  • "taskContinuation": true
}

Response samples

Content type
application/json
{ }

Remove discovered actions from all IAG adapter

Discovers all actions from all IAG adapters. This will restart this app and display a corresponding log message.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

taskContinuation
boolean (Task Continuation)
Default: true

Responses

Request samples

Content type
application/json
{
  • "taskContinuation": true
}

Response samples

Content type
application/json
{ }

Discover actions on one IAG adapter

Discovers all actions from a specified IAG adapter. This will restart this app and display a corresponding log message.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
adapterId
required
string (adapterId)

Automation Gateway adapter ID.

Responses

Response samples

Content type
application/json
{ }

Remove discovered actions from one IAG adapter

Removes all actions from a specified IAG adapter. This will restart this app and display a corresponding log message.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
adapterId
required
string (adapterId)

Automation Gateway adapter ID.

Responses

Response samples

Content type
application/json
{ }

Get all adapters in all clusters

Get all adapters in all clusters

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{ }

Applications

Get a single application.

Get a single application in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected application.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "data": {
    }
}

Update an application.

Update an application in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name for the selected application.

Request Body schema: application/json

request body

object (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Get the list of changelogs. Deprecated

Get the list of changelogs for a specific application.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected application.

query Parameters
release
string
Examples: release=0.0.1 release=0.1.0 release=1.0.0 release=1.1.1-2020.1.0

release

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get all applications.

Get all applications in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
contains
string
Examples: contains=redis

contains

containsField
string
Examples: containsField=name

containsField

equals
string
Examples: equals=redis

equals

equalsField
string
Examples: equalsField=name

equalsField

startsWith
string
Examples: startsWith=redis

startsWith

startsWithField
string
Examples: startsWithField=name

startsWithField

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": 1
}

Start an application.

Start an application in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected application.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Stop an application.

Stop an application in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected application.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Restart an application.

Restart an application in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected application.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Update the log levels.

Update the log levels for an application.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name for the selected application.

Request Body schema: application/json

request body

object (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Update the properties of an application.

Update the properties of an application in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name for the selected application.

Request Body schema: application/json

request body

properties
any (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": null
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Authentication

Gets the authorization data for the logged in user

Gets the authorization data for the logged in user

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
roles
string
Enum: "names" "ids"

roles

Responses

Response samples

Content type
application/json
{
  • "id": "5cb7b531d06cceb89fd21b1c",
  • "provenance": "Local AAA",
  • "username": "jane_doe",
  • "firstname": "Jane",
  • "groups": [
    ],
  • "roles": [
    ],
  • "roleNames": [
    ],
  • "routes": [
    ],
  • "methods": {
    }
}

Gets the session document for the active user

Gets the session for the active user

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "loginMethod": "Web",
  • "session_start": 0,
  • "ttl": 0,
  • "principalId": "string",
  • "requestCount": 0
}

Gets the principal document for the active user

Gets the principal for the active user

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{
  • "id": "5cb7b531d06cceb89fd21b1c",
  • "provenance": "Local AAA",
  • "username": "jane_doe",
  • "firstname": "Jane",
  • "groups": [
    ],
  • "roles": [
    ],
  • "roleNames": [
    ],
  • "allowedMethods": [
    ],
  • "allowedViews": [
    ],
  • "routes": [
    ]
}

Get the number of seconds until the logged in user's session expires.

Get the number of seconds until the user is logged out.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
0
0

Log in and create a session in IAP using single sign on

Log into IAP using single sign on

Responses

Response samples

Content type
application/json
null

Test logging into IAP using a saved single sign on configuration

Test logging into IAP using single sign on

path Parameters
name
required
string (name)
Examples: Auth0 Okta

The name of the SSO configuration

Responses

Response samples

Content type
application/json
null

This the route used by the SAML identity provider to callback to IAP with the authentication response. This is not meant for manual use.

Callback used by the SAML identity provider

Responses

Response samples

Content type
application/json
null

Get whether or not single sign on is enabled

Get whether or not single sign on is enabled

Responses

Response samples

Content type
application/json
true

Log in an create a session in IAP

Log in to IAP

Request Body schema: application/json

credentials

object

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
"MTQ4ZmMzMGMxOTQ2MTg4N2ZjMDhiMTY0MzlkYTgwZmM="

Log out of IAP and delete current session

Log out of IAP

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
"You have successfully logged out."

Download a public file from IAP

Download a public file from IAP

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
file_name
string

file_name

Responses

Response samples

Content type
application/json
"this is the contents of a file"

Get system server id.

Get system server id for the current IAP.

Responses

Response samples

Content type
application/json
"string"

Get verion.

Get release verion of current IAP.

Responses

Response samples

Content type
application/json
"string"

Get all application configs in IAP.

Get all application configs in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the user profile for the active user Deprecated

Gets the user profile for the active user

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
username
required
string (Username)
Examples: john_doe

The exact username for the logged in user

Responses

Response samples

Content type
application/json
{
  • "provenance": "Local AAA",
  • "username": "john_doe",
  • "firstname": "John",
  • "memberOf": [
    ],
  • "assignedRoles": [
    ],
  • "inactive": true,
  • "lastLogin": "2018-08-02T15:56:12.912Z",
  • "sso": true,
  • "nameID": "string",
  • "_meta": {
    },
  • "email": "name@email.com",
  • "isServiceAccount": true,
  • "loggedIn": true,
  • "gitTokens": {
    }
}

Updates the user profile for the active user Deprecated

Updates the user profile for the active user

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

userProfile

username
required
string (iap_accounts-schema_username)

Username for account

email
string (iap_accounts-schema_email)

Email for user

Responses

Request samples

Content type
application/json
{
  • "username": "john_doe",
  • "email": "name@email.com"
}

Response samples

Content type
application/json
{
  • "provenance": "Local AAA",
  • "username": "john_doe",
  • "firstname": "John",
  • "memberOf": [
    ],
  • "assignedRoles": [
    ],
  • "inactive": true,
  • "lastLogin": "2018-08-02T15:56:12.912Z",
  • "sso": true,
  • "nameID": "string",
  • "_meta": {
    },
  • "email": "name@email.com",
  • "isServiceAccount": true,
  • "loggedIn": true,
  • "gitTokens": {
    }
}

Authorization

Get all accounts.

Get all accounts

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
object (iap_authorization-common_accounts-query)

multiContains

object (iap_authorization-common_accounts-query)

multiEquals

object (iap_authorization-common_accounts-query)

multiStartsWith

inactive
boolean (Inactive)

inactive

isServiceAccount
boolean (iap_accounts-schema_isServiceAccount)

isServiceAccount

groupId
string (iap_common-schema_objectId) ^[0-9a-f]{24}$
Examples: groupId=5cb7b531d06cceb89fd21b1c

groupId

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

loggedIn
boolean (iap_accounts-schema_loggedIn)

loggedIn

Responses

Response samples

Content type
application/json
{
  • "results": {
    },
  • "total": 1
}

Get an individual account.

Get an individual account

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
accountId
required
string (iap_common-schema_objectId) ^[0-9a-f]{24}$
Examples: 5cb7b531d06cceb89fd21b1c

The id for the requested account.

Responses

Response samples

Content type
application/json
{
  • "provenance": "Local AAA",
  • "username": "john_doe",
  • "firstname": "John",
  • "memberOf": [
    ],
  • "assignedRoles": [
    ],
  • "inactive": true,
  • "lastLogin": "2018-08-02T15:56:12.912Z",
  • "sso": true,
  • "nameID": "string",
  • "_meta": {
    },
  • "email": "name@email.com",
  • "isServiceAccount": true,
  • "loggedIn": true,
  • "gitTokens": {
    }
}

Update an account.

Update an account

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
accountId
required
string (iap_common-schema_objectId) ^[0-9a-f]{24}$
Examples: 5cb7b531d06cceb89fd21b1c

The individual account to update.

Request Body schema: application/json

request body

object (updates)

Responses

Request samples

Content type
application/json
{
  • "updates": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Force a user to logout and remove their session.

Force a user to logout

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
accountId
required
string (iap_common-schema_objectId) ^[0-9a-f]{24}$
Examples: 5cb7b531d06cceb89fd21b1c

The individual account to logout.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Get a list of groups.

Get a list of groups

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
object (iap_authorization-common_groups-query)

multiContains

object (iap_authorization-common_groups-query)

multiEquals

object (iap_authorization-common_groups-query)

multiStartsWith

inactive
boolean (Inactive)

inactive

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

refresh
boolean (refresh)
Default: false

whether to refresh groups from AAA

Responses

Response samples

Content type
application/json
{
  • "results": {
    },
  • "total": 1
}

Create a group.

Create a group

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (iap_groups-schema)

This is the schema for an IAP group stored in Mongo

Responses

Request samples

Content type
application/json
{
  • "group": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Get a simplified list of groups.

Get a simplified list of groups

query Parameters
object (iap_authorization-common_groups-query)

multiContains

object (iap_authorization-common_groups-query)

multiEquals

object (iap_authorization-common_groups-query)

multiStartsWith

inactive
boolean (Inactive)

inactive

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

refresh
boolean (refresh)
Default: false

whether to refresh groups from AAA

Responses

Response samples

Content type
application/json
{
  • "results": {
    },
  • "total": 1
}

Get an individual group.

Get an individual group

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
groupId
required
string (iap_common-schema_objectId) ^[0-9a-f]{24}$
Examples: 5cb7b531d06cceb89fd21b1c

The id for the requested group.

Responses

Response samples

Content type
application/json
{
  • "provenance": "Local AAA",
  • "name": "group_1",
  • "description": "description of group_1",
  • "memberOf": [
    ],
  • "assignedRoles": [
    ],
  • "inactive": true,
  • "_meta": {
    }
}

Update a group.

Update a group

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
groupId
required
string (iap_common-schema_objectId) ^[0-9a-f]{24}$
Examples: 5cb7b531d06cceb89fd21b1c

The individual group to update.

Request Body schema: application/json

request body

object (updates)

Responses

Request samples

Content type
application/json
{
  • "updates": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Delete a group.

Delete a group

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
groupId
required
string (iap_common-schema_objectId) ^[0-9a-f]{24}$
Examples: 5cb7b531d06cceb89fd21b1c

The individual group to delete.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Get a list of roles.

Get a list of roles

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
object (iap_authorization-common_roles-query)

multiContains

object (iap_authorization-common_roles-query)

multiEquals

object (iap_authorization-common_roles-query)

multiStartsWith

inactive
boolean

inactive

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

Responses

Response samples

Content type
application/json
{
  • "results": {
    },
  • "total": 1
}

Create a role.

Create a role

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (iap_roles-schema)

This is the schema for an IAP role stored in Mongo

Responses

Request samples

Content type
application/json
{
  • "role": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Get an individual role.

Get an individual role

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
roleId
required
string (roleId)
Examples: Authorization.admin

The id for the requested role.

Responses

Response samples

Content type
application/json
{
  • "provenance": "Custom",
  • "name": "role_1",
  • "description": "description of role_1",
  • "allowedMethods": [
    ],
  • "allowedViews": [
    ],
  • "_meta": {
    }
}

Update a role.

Update a role

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
roleId
required
string (roleId)
Examples: Authorization.admin

The individual role to update.

Request Body schema: application/json

request body

object (updates)

Responses

Request samples

Content type
application/json
{
  • "updates": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Delete a role.

Delete a role

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
roleId
required
string (roleId)
Examples: Authorization.admin

The individual role to delete.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Get a list of methods.

Get a list of methods in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
object (iap_system-common_methods-query)

multiContains

object (iap_system-common_methods-query)

multiEquals

object (iap_system-common_methods-query)

multiStartsWith

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": 1
}

Get a list of views.

Get a list of views in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
object (iap_system-common_views-query)

multiContains

object (iap_system-common_views-query)

multiEquals

object (iap_system-common_views-query)

multiStartsWith

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": 1
}

Extract CSV data of accounts, groups, and roles

Retrieve CSV data of accounts, groups, and roles information

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
"string"

Automation Studio

A suite of tools for designing workflows, templates, and forms.

Gets a page of template documents.

Gets a page of template documents.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
limit
integer >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

Number of results to return. Used for pagination.

skip
integer >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

Number of results to skip. Used for pagination.

order
integer
Default: 1
Enum: -1 1

Sort direction, 1 for ascending and -1 for descending.

sort
string
Default: "name"
Value: "name"

Field to sort by

exclude-project-members
boolean

Flag which removes workflows from the results which are members of a project

include
string
Examples: include=name include=description include=name,description

Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.

exclude
string
Examples: exclude=_id exclude=description exclude=_id,description

Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.

in
string

Search for fields exactly matching one of the given list options

not-in
string

Search for fields not exactly matching one of the given list options

equals
string

Returns results where the specified fields exactly match the given match string(s).

contains
string

Returns results where the specified fields contain the given match string(s).

starts-with
string

Returns results where the specified fields start with the given match string(s).

ends-with
string

Returns results where the specified fields end in the given match string(s).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "count": 0,
  • "next": "string",
  • "previous": "string"
}

Creates a new template document.

Creates a new template document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (automation-studio_template)

An entity representing a data template.

Responses

Request samples

Content type
application/json
{
  • "template": {
    }
}

Response samples

Content type
application/json
{
  • "created": {
    },
  • "edit": "string"
}

Gets a single template document.

Gets a single template document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (id)

ObjectId specifying a template entity.

query Parameters
include
string
Examples: include=name include=description include=name,description

Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.

exclude
string
Examples: exclude=_id exclude=description exclude=_id,description

Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.

Responses

Response samples

Content type
application/json
{ }

Deletes a template document.

Deletes a template document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (id)

Template id.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Replaces a template document.

Replaces a template document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (id)

Template id.

Request Body schema: application/json

request body

object (automation-studio_templateUpdate)

An entity representing an update to an existing template document.

Responses

Request samples

Content type
application/json
{
  • "update": {
    }
}

Response samples

Content type
application/json
{
  • "updated": {
    },
  • "edit": "string"
}

Imports a new template document.

Imports a new template document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

Array of Template Import Data (object) or Template Import Data (object) (templates)

Array of template documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'. If a template's name is already used in the templates collection, it will be renamed with a numeric suffix.

Responses

Request samples

Content type
application/json
{
  • "templates": [
    ]
}

Response samples

Content type
application/json
{
  • "imported": [
    ]
}

Exports a template document.

Exports a template document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (id)

Template id.

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "arista_eos_show_clock",
  • "projectId": { },
  • "group": "Arista",
  • "device": "Arista EOS",
  • "command": "show clock",
  • "description": "Arista Show Clock Info",
  • "template": "Value TIME (d+:d+:d+)\nValue TIMEZONE (S+)\nValue DAYWEEK (w+)\nValue MONTH (w+)\nValue DAY (d+)\nValue YEAR (d+)\n\nStart\n ^${DAYWEEK}s+${MONTH}s+${DAY}s+${TIME}s+${YEAR}\n ^[t|T]imezone(:|sis)s+${TIMEZONE} -> Record\n",
  • "data": "Mon Jan 14 18:42:49 2013\ntimezone is US/Central",
  • "text": "Mon Jan 14 18:42:49 2013\ntimezone is US/Central",
  • "type": "textfsm",
  • "createdBy": "string",
  • "created": "2019-11-25T22:51:39.201Z",
  • "lastModifiedBy": "string",
  • "lastUpdated": "2019-11-25T22:51:39.201Z",
  • "version": 1,
  • "tags": [
    ]
}

Get all available rest calls in IAP.

Get all available rest calls in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of all the apps and adapters

Get all apps and adapters.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets a page of workflow documents.

Gets a page of workflow documents.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
limit
integer >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

Number of results to return. Used for pagination.

skip
integer >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

Number of results to skip. Used for pagination.

order
integer
Default: 1
Enum: -1 1

Sort direction, 1 for ascending and -1 for descending.

sort
string
Default: "name"
Value: "name"

Field to sort by

exclude-project-members
boolean

Flag which removes workflows from the results which are members of a project

include
string
Examples: include=name include=description include=name,description

Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.

exclude
string
Examples: exclude=_id exclude=description exclude=_id,description

Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.

expand
string (List of fields to get expanded data)
Examples: expand=created_by,user,owner

Sets the fields to expand. Generally, these are fields like "metrics.user", "metrics.owner", "created_by", etc

in
string
Examples: in=in[name]=my-workflow,or-this-workflow&in[type]=automation

Search for fields exactly matching one of the given list options

not-in
string
Examples: not-in=not-in[name]=my-workflow,not-this-workflow

Search for fields not exactly matching one of the given list options

equals
string
Examples: equals=equals[name]=my-workflow

Returns results where the specified fields exactly match the given match string(s).

contains
string
Examples: contains=contains[name]=workflow

Returns results where the specified fields contain the given match string(s).

starts-with
string
Examples: starts-with=starts-with[name]=my-

Returns results where the specified fields start with the given match string(s).

ends-with
string
Examples: ends-with=ends-with[name]=-workflow

Returns results where the specified fields end in the given match string(s).

task-equals
string
Examples: task-equals=task-equals[app]=WorkFlowEngine

Returns results where one or more tasks have fields that exactly match the given match string(s).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "count": 0,
  • "limit": 0,
  • "next": "string",
  • "previous": "string"
}

Get Details of a Workflow

Get the details of a Workflow by Workflow name.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)

Name of Workflow to get Workflow details.

Responses

Response samples

Content type
application/json
{
  • "_id": "4321abcdef694aa79dae47ad",
  • "namespace": {
    },
  • "name": "Port Turn Up IOS",
  • "type": "automation",
  • "description": "Port Turn Up IOS",
  • "preAutomationTime": 5000,
  • "tasks": {
    },
  • "transitions": {
    },
  • "font_size": 12,
  • "groups": [
    ],
  • "created": "2024-03-13T18:21:15.352Z",
  • "created_by": null,
  • "last_updated": "2024-03-13T18:21:15.352Z",
  • "last_updated_by": null,
  • "lastUpdatedVersion": "4.69.69",
  • "tags": [
    ],
  • "canvasVersion": 3,
  • "encodingVersion": 1
}

Creates a new workflow document.

Creates a new workflow document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (automation-studio_automation)

Third generation workflow document

Responses

Request samples

Content type
application/json
{
  • "automation": {
    }
}

Response samples

Content type
application/json
{
  • "created": {
    },
  • "edit": "string"
}

Replaces a workflow document.

Replaces a workflow document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (id)

Workflow id.

Request Body schema: application/json

request body

object (automation-studio_automationUpdate)

Third generation workflow document

Responses

Request samples

Content type
application/json
{
  • "update": {
    }
}

Response samples

Content type
application/json
{
  • "updated": {
    },
  • "edit": "string"
}

Imports a new workflow document.

Imports a new workflow document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

Array of objects (automations)

Array of workflow documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'.

Responses

Request samples

Content type
application/json
{
  • "automations": [
    ]
}

Response samples

Content type
application/json
{
  • "imported": [
    ]
}

Gets a page of component group documents.

Gets a page of component group documents.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
limit
integer >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

Number of results to return. Used for pagination.

skip
integer >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

Number of results to skip. Used for pagination.

order
integer
Default: 1
Enum: -1 1

Sort direction, 1 for ascending and -1 for descending.

sort
string
Default: "name"
Value: "name"

Field to sort by

include
string
Examples: include=name include=description include=name,description

Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.

exclude
string
Examples: exclude=_id exclude=description exclude=_id,description

Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.

in
string

Search for fields exactly matching one of the given list options

not-in
string

Search for fields not exactly matching one of the given list options

equals
string

Returns results where the specified fields exactly match the given match string(s).

contains
string

Returns results where the specified fields contain the given match string(s).

starts-with
string

Returns results where the specified fields start with the given match string(s).

ends-with
string

Returns results where the specified fields end in the given match string(s).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 100,
  • "start": 0,
  • "end": 100,
  • "count": 100,
  • "next": "string",
  • "previous": "string"
}

Creates a new component group document.

Creates a new component group document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (automation-studio_componentGroup)

An entity representing a component group.

Responses

Request samples

Content type
application/json
{
  • "componentGroup": {
    }
}

Response samples

Content type
application/json
{
  • "created": {
    },
  • "edit": "string"
}

Gets a single component group document.

Gets a single component group document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (id)

ObjectId specifying a component group entity.

query Parameters
include
string
Examples: include=name include=description include=name,description

Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.

exclude
string
Examples: exclude=_id exclude=description exclude=_id,description

Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.

Responses

Response samples

Content type
application/json
{
  • "_id": "67d863a07620432ed58f7964",
  • "name": "Automation Studio",
  • "description": "",
  • "gbacRead": [ ],
  • "gbacWrite": [ ],
  • "members": [
    ]
}

Deletes a component group document.

Deletes a component group document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (id)

Component group id.

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted componentGroup 67d32e60a402649caa29a006"
}

Replaces a component group document.

Replaces a component group document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (id)

Component group id.

Request Body schema: application/json

request body

object (automation-studio_componentGroupUpdate)

An entity representing an update to an existing template document.

Responses

Request samples

Content type
application/json
{
  • "update": {
    }
}

Response samples

Content type
application/json
{
  • "updated": {
    },
  • "edit": "string"
}

Imports a new component group document.

Imports a new component group document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

Array of objects (componentGroups)

Array of component group documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'. If a component group's name is already used in the component groups collection, it will be renamed with a numeric suffix.

Responses

Request samples

Content type
application/json
{
  • "componentGroups": [
    ]
}

Response samples

Content type
application/json
{
  • "imported": [
    ]
}

Validate a workflow

Validate a workflow, and return the resulting errors and warnings arrays.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (automation-studio_workflowDocumentAll)

Accepts all generation workflow documents

Responses

Request samples

Content type
application/json
{
  • "workflow": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "warnings": [
    ]
}

Gets references to a particular document. Deprecated

Gets references to a particular document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
target-type
string

Type of document to search for references to.

target-identifiers
string

IDs of the components to search for references to.

referrer-type
string

Type of documents to search for references in.

Responses

Response samples

Content type
application/json
{
  • "referencesByTarget": [
    ]
}

Get Task Details

Get the detailed information model for a task

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
location
required
string (location)

Location: Application, Broker, Adapter

pckg
required
string (pckg)
Examples: WorkFlowEngine

Package name

method
required
string (method)
Examples: query merge

Method name

Responses

Response samples

Content type
application/json
{
  • "location": "Application",
  • "name": "query",
  • "app": "WorkFlowEngine",
  • "variables": {
    }
}

Get Task Details

Get the detailed information model for a task

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

Array of objects (inputsArray)

Responses

Request samples

Content type
application/json
{
  • "inputsArray": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Search projects

Search projects

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully retrieved projects",
  • "data": [
    ],
  • "metadata": {
    }
}

Creates a new project

Creates a new project

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

createData

name
required
string

Project name

description
string (Project description)

A free-form block of text for describing project intent and function

Array of objects (Project components)

A list of member components in the project

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "Firewall Service Provisioning",
  • "description": "This project is used at Acme Corp as the foundation of some major parts of our business process.",
  • "components": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully created project",
  • "data": { },
  • "metadata": { }
}

Gets a single Project

Gets a single Project

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
projectId
required
string (projectId)

Project identifier

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully retrieved project",
  • "data": { },
  • "metadata": { }
}

Updates an existing project

Updates an existing project

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
required
MongoDB ObjectId (string) or IID (integer) (Projects HTTP ID)

Project identifier, either an ObjectId or an IID

Request Body schema: application/json

updateData

name
string

Project name

description
string (Project description)

A free-form block of text for describing project intent and function

thumbnailBackgroundColor
string
Default: "#FFFFFF"

Thumbnail background color

Array of objects
object
object
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "Firewall Service Provisioning",
  • "description": "This project is used at Acme Corp as the foundation of some major parts of our business process.",
  • "thumbnailBackgroundColor": "#FFFFFF",
  • "members": [
    ],
  • "version": {
    },
  • "gitConfiguration": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": { },
  • "metadata": { }
}

Exports a project document as a JSON document, inlining all related documents into its components array

Exports a project document as a JSON document, inlining all related documents into its components array

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (id)

id

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully exported project",
  • "data": { },
  • "metadata": { }
}

Imports a project document from a JSON document

Imports a project document from a JSON document

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

options

object (automation-studio_projects-export-v1)

An exported project document

conflictMode
string
Enum: "overwrite" "insert-new"
skipReferenceValidation
boolean
Default: false

If true, validations will not be run against references.

assignNewReferences
boolean
Default: false

This being true would indicate that the imported project is part of a clone action.

Responses

Request samples

Content type
application/json
{
  • "project": {
    },
  • "conflictMode": "overwrite",
  • "skipReferenceValidation": false,
  • "assignNewReferences": false
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": { },
  • "metadata": { }
}

Discover referenced resources

Finds all resource references from a set of specified resource identifiers

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

options

Array of objects

Array of resource identifiers to find references for.

recursive
boolean
Default: false

If true, recursively looks up resources on all referenced resources.

includeResources
boolean
Default: false

If true, include the full resource document in each resource reference object.

object

An object of resource types to directions that will not be included in discovery. Cannot be used with include.

object

An object of resource types and directions to be included in discovery. Cannot be used with ignore.

removeCycles
boolean
Default: false

If true, removes all cyclic relationships from the list of resource references.

Responses

Request samples

Content type
application/json
{
  • "resourceIdentifiers": [
    ],
  • "recursive": false,
  • "includeResources": false,
  • "ignore": {
    },
  • "include": {
    },
  • "removeCycles": false
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": { },
  • "metadata": { }
}

Delete a project and any components it contains

Delete a project and any components it contains

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (id)

Project ID

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Remove a component from a project

Remove a component from a project

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
projectId
required
string (projectId)

Project identifier

componentId
required
number (componentId)

Component identifier

Request Body schema: application/json

request body

object (options)

Options designating removal mode

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "metadata": { }
}

Add one or more components to Project

Add one or more components to Project

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
projectId
required
string (projectId)

Project identifier

Request Body schema: application/json

options

required
Array of objects (automation-studio_projects-common_components)

A list of member components in the project

mode
string
Enum: "move" "copy"

Responses

Request samples

Content type
application/json
{
  • "components": [
    ],
  • "mode": "move"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "metadata": {
    }
}

Set a project's thumbnail image

Set a project's thumbnail image

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
projectId
required
string (projectId)

Project identifier

Request Body schema: application/json

options

imageData
required
string

Binary image data encoded as a base64 string

backgroundColor
string
Default: "#FFFFFF"

Thumbnail background color

Responses

Request samples

Content type
application/json
{
  • "imageData": "string",
  • "backgroundColor": "#FFFFFF"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "metadata": { }
}

Gets a Project's thumbnail

Gets a Project's thumbnail. Returns data as a base64 encoded string of binary data.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
projectId
required
string (projectId)

Project identifier

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully retrieved project thumbnail",
  • "data": {
    }
}

Configuration Manager

Find Devices

Gets a specific subset of devices for based on given options

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "entity": "device",
  • "total": 0,
  • "unique_device_count": 0,
  • "return_count": 0,
  • "start_index": 0,
  • "list": [
    ]
}

Fetches OS Types to store into the cache.

Gathers all the device OS Types in the current evnironment and stores them in the cache.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{ }

Fetches the OSTypes stored in the cache.

Gathers all the device OS Types in the current cache.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{ }

Deletes the cache for os types.

Removes the cache in the database for os type values.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

options
object (options)

Responses

Request samples

Content type
application/json
{
  • "options": { }
}

Response samples

Content type
application/json
"Successfully deleted the cache for device os types."

Deletes pinned items.

Deletes the pinned items permanently from the database.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

pinTargets
Array of any (pinTargets)
sourceItem
string (sourceItem)

Responses

Request samples

Content type
application/json
{
  • "pinTargets": [
    ],
  • "sourceItem": "string"
}

Response samples

Content type
application/json
{ }

Add an item to pins or remove from if it already exists

Add an item to pins or remove from if it already exists

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{ }

Get a list of pinned items.

Fetches a list of pinned items based on the input parameters. The list of pinned items are specific to the current user or actor. This api supports pagination.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "pins": [
    ],
  • "count": "10"
}

Checks if the current version of CM is maintenance or not.

Returns a boolean reflecting whether the current Configuration Manager bundle is a maintenance bundle.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
true

Renders a jinja2 template.

Takes a jinja2 template a renders output text.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

template
string (template)
variables
object (variables)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "template": "this is a {{ varName }} template",
  • "variables": { },
  • "options": { }
}

Response samples

Content type
application/json
"this is a jinja2 template"

Get data for all adapters with tasks.

Fetch method/task metadata for all adapters that have it.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

options
object (options)

Responses

Request samples

Content type
application/json
{
  • "options": { }
}

Response samples

Content type
application/json
{
  • "adapterTasks": { }
}

Get data for a specific adapter task.

Fetch method/task metadata for an adapter task.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

taskName
string (taskName)
origin
string (origin)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "taskName": "getConfig",
  • "origin": "nso52",
  • "options": { }
}

Response samples

Content type
application/json
{
  • "adapterTasks": { }
}

Create a task instance.

Create an instance of a task and save it to the database.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

instanceName
string (instanceName)
origin
string (origin)
taskName
string (taskName)
treeId
string (treeId)
taskParams
object (taskParams)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "instanceName": "string",
  • "origin": "nso52",
  • "taskName": "getConfig",
  • "treeId": "5f21c92ba6abf82bf5041783",
  • "taskParams": { },
  • "options": { }
}

Response samples

Content type
application/json
{ }

Update a task instance.

Update an instance of a task and save it to the database.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

taskId
string (taskId)
treeId
string (treeId)
taskParams
object (taskParams)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "taskId": "string",
  • "treeId": "string",
  • "taskParams": { },
  • "options": { }
}

Response samples

Content type
application/json
{ }

Delete task instance(s).

Delete task instance(s) from the database.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

taskIds
Array of any (taskIds)
treeId
string (treeId)

Responses

Request samples

Content type
application/json
{
  • "taskIds": [
    ],
  • "treeId": "string"
}

Response samples

Content type
application/json
{ }

Get task instance(s).

Get instance(s) of a task.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (treeId)
object (options)

Responses

Request samples

Content type
application/json
{
  • "treeId": "5f21c92ba6abf82bf5041783",
  • "options": {
    }
}

Response samples

Content type
application/json
{ }

Search for task instance(s).

Search for task instance(s) using varies options parameters.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{ }

Run a task instance.

Run an instance of a task and save it to the database.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

taskId
string (taskId)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "taskId": "string",
  • "options": { }
}

Response samples

Content type
application/json
{ }

Run an adapter task.

Run an adapter task.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

origin
string (origin)
taskName
string (taskName)
args
object (args)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "origin": "string",
  • "taskName": "string",
  • "args": { },
  • "options": { }
}

Response samples

Content type
application/json
{ }

Get Device Details

Get detailed information for a specific device, based on its device name

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: xr9kv-atl

Device name

Responses

Response samples

Content type
application/json
{
  • "name": "xr9kv01-aws",
  • "authgroup": "xr9kv-aws",
  • "ipaddress": "10.1.6.100",
  • "address": "10.1.6.100",
  • "port": "22",
  • "device-type": "cli",
  • "ostype": "cisco-ios-xr",
  • "ned": "cisco-ios-xr",
  • "admin": true,
  • "host": "nso46",
  • "actions": [
    ],
  • "origins": [
    ]
}

Get Device Configuration

Get configuration for a specific device

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: xr9kv-atl

Device name

Responses

Response samples

Content type
application/json
{
  • "device": "xr9kv-atl",
  • "config": "hostname ios0\nno service password-encryption\n..."
}

Get formatted device config Deprecated

Get device configuration in a given format.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: xr9kv-atl

Device name

format
required
string (format)
Enum: "native" "xml" "json"
Examples: native

Supported formats by NSO (xml, native, json) & Automation Gateway (native).

Responses

Response samples

Content type
application/json
{
  • "device": "xr9kv-atl",
  • "config": "hostname ios0\nno service password-encryption\n..."
}

Backup device configuration

Backup device configuration in mongo

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

name
string (configuration_manager_deviceData_deviceName)
object (options)

Responses

Request samples

Content type
application/json
{
  • "name": "xr9kv-atl",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Device {deviceName} backed up successfully"
}

Import backup documents

Insert backup documents into the ucm_configs collection

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

Array of objects (backups)

Responses

Request samples

Content type
application/json
{
  • "backups": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "2 device backups imported successfully"
}

Import device group documents

Insert device group documents into the device_groups collection

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

Array of objects (groups)

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "2 device groups imported successfully"
}

Get Device Backup List

Fetches backups, requires an options payload. An empty option payload will return the first 25 documents

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "list": [
    ]
}

Delete one or more device backups by Id

This API call will delete device backups based on given Ids

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

backupIds
Array of strings (backupIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "backupIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "deleted": 0
}

Gets a list of all backed up devices

Returns a list of devices that have one or more backups

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
[
  • "xr9kv-atl"
]

Get Device Backup

Retrieves single backup document by id

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

Backup's id

Responses

Response samples

Content type
application/json
{
  • "id": "5c35355dbebaa82eaf8113f0",
  • "name": "xr9kv-atl",
  • "provider": "string",
  • "type": "native",
  • "date": "2019-04-12T14:42:47.958Z",
  • "rawConfig": "hostname ios0\nno service password-encryption\n...",
  • "description": "description of backup",
  • "notes": "notes about backup",
  • "gbac": {
    }
}

Update a device backup by Id

This API call will update the metadata of a device backup by ID

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

Backup Id

Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "updated": 0
}

Get Device Group by Name

Retrieves a single group document by name

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

groupName
string (configuration_manager_common_standardName) non-empty

Responses

Request samples

Content type
application/json
{
  • "groupName": "my standard name"
}

Response samples

Content type
application/json
{
  • "_id": "5c35355dbebaa82eaf8113f0",
  • "name": "my standard name",
  • "description": "my standard description",
  • "devices": [
    ]
}

Gets device groups for a device

Finds all the device groups that contain the specified device

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
deviceName
required
string (name)
Examples: xr9kv-atl

Device name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Check if device is connected

Get connection status of device

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: xr9kv-atl

Device name

Responses

Response samples

Content type
application/json
true

Creates a device group

Creates a new device group in pronghorn

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

groupName
string (configuration_manager_common_standardName) non-empty
groupDescription
string (configuration_manager_common_standardDescription) non-empty
deviceNames
string (configuration_manager_common_multiElementString) non-empty

Responses

Request samples

Content type
application/json
{
  • "groupName": "my standard name",
  • "groupDescription": "my standard description",
  • "deviceNames": "device1, device2, device3, device4"
}

Response samples

Content type
application/json
{
  • "id": "5c35355dbebaa82eaf8113f0",
  • "name": "string",
  • "message": "string",
  • "status": "string"
}

Get all Device Groups

Gets a list of all known device groups

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete device groups

Delete specified device groups

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

groupIds
Array of strings (groupIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "groupIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "deleted": 0
}

Search all Device Groups

Gets a list of all device groups that match the search criteria

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

s
string (s)
start
number (start)
limit
number (limit)

Responses

Request samples

Content type
application/json
{
  • "s": "string",
  • "start": 0,
  • "limit": 0
}

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "groups": [
    ]
}

Search device groups

Returns device groups that match the specified input

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

name
string (name)
start
number (start)
limit
number (limit)
object (options)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "start": 0,
  • "limit": 0,
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "groups": [
    ]
}

Get Device Group by ID

Get Device Group by ID

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

Group Id or Group Name

Responses

Response samples

Content type
application/json
{
  • "_id": "5c35355dbebaa82eaf8113f0",
  • "name": "my standard name",
  • "description": "my standard description",
  • "devices": [
    ]
}

Update device groups

Updates the device group's details and devices.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

Group Id

Request Body schema: application/json

request body

object (configuration_manager_deviceGroupDocument_updateGroupDetails)

Responses

Request samples

Content type
application/json
{
  • "details": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "modified": 0
}

Removes devices from a group

Removes devices from a device group

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (id)

id

Request Body schema: application/json

request body

devices
Array of any (devices)

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ]
}

Response samples

Content type
application/json
{ }

Adds new devices to the group

Adds devices to a group

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (id)

id

Request Body schema: application/json

request body

devices
Array of any (devices)

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ]
}

Response samples

Content type
application/json
{ }

Delete device groups

Delete specified device groups

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

groupNames
Array of strings (groupNames) [ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "groupNames": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "deleted": 0
}

Add device(s) to a group Deprecated

This API call will add device(s) to a device group

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

groupName
string (configuration_manager_common_standardName) non-empty
deviceNames
string (configuration_manager_common_multiElementString) non-empty

Responses

Request samples

Content type
application/json
{
  • "groupName": "my standard name",
  • "deviceNames": "device1, device2, device3, device4"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "modified": 0
}

Delete device(s) from a group Deprecated

This API call will delete device(s) from a device group

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

groupName
string (configuration_manager_common_standardName) non-empty
deviceNames
string (configuration_manager_common_multiElementString) non-empty

Responses

Request samples

Content type
application/json
{
  • "groupName": "my standard name",
  • "deviceNames": "device1, device2, device3, device4"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "modified": 0
}

Diff two strings from a lookup.

Lookup two strings and return a diff.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

id
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
nextId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
collection
string (collection) non-empty
nextCollection
string (nextCollection) non-empty
object (options)

Responses

Request samples

Content type
application/json
{
  • "id": "5c35355dbebaa82eaf8113f0",
  • "nextId": "5c35355dbebaa82eaf8113f0",
  • "collection": "string",
  • "nextCollection": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
[
  • [
    ],
  • [
    ],
  • [
    ],
  • [
    ],
  • [
    ]
]

Create a config parser.

Create rules for a parser for breaking down configs in GC.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

name
string (name) non-empty
lexRules
Array of strings (lexRules) [ items ]
template
string (template)
Enum: "cisco-ios" "f5-bigip"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lexRules": [
    ],
  • "template": "cisco-ios"
}

Response samples

Content type
application/json
{ }

Update a config parser.

Update rules for a parser for breaking down configs in GC.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

name
string (name) non-empty
object (options)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "updated": 0
}

Delete a config parser.

Permanently delete a configuration parser.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

name
string (name) non-empty
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "options": { }
}

Response samples

Content type
application/json
{ }

Get all config parsers.

Gets a list of all known config parsers.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
start
integer >= 0
Examples: start=0

start

limit
integer >= 1
Examples: limit=20

limit

regex
boolean

regex

object

filter

object

sort

Responses

Response samples

Content type
application/json
[
  • null
]

Get a config parser.

Get a defined Config Parser from the database.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (filter)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "options": { }
}

Response samples

Content type
application/json
{
  • "parser": { }
}

Delete one or more config parsers by Id

This API call will delete config parsers based on given Ids

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

parserIds
Array of strings (parserIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "parserIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "deleted": 0
}

Import parser documents

Insert parser documents into the ucm_configs collection

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

parsers
Array of any (parsers)

Responses

Request samples

Content type
application/json
{
  • "parsers": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "2 device parsers imported successfully"
}

Get a list of all Golden Config trees.

Get a list of all Golden Config trees.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds a new Golden Config tree

Adds a new Golden Config tree

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

name
string (name)
deviceType
string (deviceType)

Responses

Request samples

Content type
application/json
{
  • "name": "Cisco Edge - Day 0",
  • "deviceType": "cisco-ios"
}

Response samples

Content type
application/json
{
  • "id": "5c35355dbebaa82eaf8113f0",
  • "name": "Cisco Edge - Day 0",
  • "deviceType": "cisco-ios",
  • "version": "initial",
  • "root": {
    },
  • "variables": [
    ],
  • "created": "2019-04-12T14:42:47.958Z",
  • "createdBy": "5c35355dbebaa82eaf8113f0",
  • "lastUpdated": "2019-04-12T14:42:47.958Z",
  • "lastUpdatedBy": "5c35355dbebaa82eaf8113f0"
}

Delete one or more golden configuration trees by tree id

This API call will delete golden configuration trees based on given tree ids

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeIds
Array of strings (treeIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "treeIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "deleted": 0
}

Get summary of a Golden Config tree.

Get summary of the specified Golden Config tree.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds a new Golden Config tree

Adds a new Golden Config tree

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

ID of the new Golden Config tree

Request Body schema: application/json

request body

version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
base
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)

Responses

Request samples

Content type
application/json
{
  • "version": "initial",
  • "base": "initial"
}

Response samples

Content type
application/json
{
  • "id": "5c35355dbebaa82eaf8113f0",
  • "name": "Cisco Edge - Day 0",
  • "deviceType": "cisco-ios",
  • "version": "initial",
  • "root": {
    },
  • "variables": [
    ],
  • "created": "2019-04-12T14:42:47.958Z",
  • "createdBy": "5c35355dbebaa82eaf8113f0",
  • "lastUpdated": "2019-04-12T14:42:47.958Z",
  • "lastUpdatedBy": "5c35355dbebaa82eaf8113f0"
}

Updates properties of a Golden Config tree

Updates properties of the specified Golden Config tree

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Golden Config tree updated"
}

Delete a Golden Config tree.

Deletes the specified Golden Config tree.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Golden Config tree deleted"
}

Get details of a Golden Config tree version.

Get a detailed view of the specified Golden Config tree version.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

version
required
string (goldenConfigTreeVersionName)
Examples: initial v2 v3 draft-v4

version

Responses

Response samples

Content type
application/json
{
  • "id": "5c35355dbebaa82eaf8113f0",
  • "name": "Cisco Edge - Day 0",
  • "deviceType": "cisco-ios",
  • "version": "initial",
  • "root": {
    },
  • "variables": [
    ],
  • "created": "2019-04-12T14:42:47.958Z",
  • "createdBy": "5c35355dbebaa82eaf8113f0",
  • "lastUpdated": "2019-04-12T14:42:47.958Z",
  • "lastUpdatedBy": "5c35355dbebaa82eaf8113f0"
}

Updates properties of a Golden Config tree version

Updates properties of the specified Golden Config tree version

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

version
required
string (goldenConfigTreeVersionName)
Examples: initial v2 v3 draft-v4

version

Request Body schema: application/json

request body

name
string (name)
variables
object (variables)

Responses

Request samples

Content type
application/json
{
  • "name": "updated version name",
  • "variables": { }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Configuration tree version updated"
}

Delete a Golden Config tree.

Deletes the specified Golden Config tree.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

version
required
string (goldenConfigTreeVersionName)
Examples: initial v2 v3 draft-v4

version

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Configuration tree version deleted"
}

Get summary of a Golden Config tree.

Get summary of the specified Golden Config tree.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
object (options)

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "options": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Find trees which contain the specified device.

Search through all GC Trees to find all locations where a device exists.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

deviceName
string (configuration_manager_deviceData_deviceName)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "deviceName": "xr9kv-atl",
  • "options": { }
}

Response samples

Content type
application/json
[
  • null
]

Fetches all the devices that exist on a tree.

Search through a GC Tree to find all the devices that exist on it.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
object (options)

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "devices": [
    ]
}

Deletes one or more variables

Verifies and deletes the requested deletion variables

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

version
required
string (goldenConfigTreeVersionName)
Examples: initial v2 v3 draft-v4

version

Request Body schema: application/json

request body

Array of objects or object (configuration_manager_goldenConfigData_goldenConfigVariables)

Responses

Request samples

Content type
application/json
{
  • "variables": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Deletion successful."
}

Updates the config rule set of a JSON Golden Config tree version

Updates the config rule set of a JSON Golden Config tree version

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
nodePath
string (configuration_manager_goldenConfigData_goldenConfigNodePath)
ruleSet
object (ruleSet)

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "ruleSet": { }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Rule Set successfully updated."
}

Remove Device Groups from Node

Remove device groups from a node in a Golden Config tree

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
nodePath
string (configuration_manager_goldenConfigData_goldenConfigNodePath)
deviceGroups
Array of strings (deviceGroups) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "deviceGroups": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Golden Config node updated"
}

Add Device Groups to Node

Add device groups to a node in a Golden Config tree

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
nodePath
string (configuration_manager_goldenConfigData_goldenConfigNodePath)
deviceGroups
Array of strings (deviceGroups) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "deviceGroups": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Golden Config node updated"
}

Export a Golden Config tree.

Exports the specified Golden Config tree.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Import golden config tree documents

Insert golden config documents into the golden config collection

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

Array of objects (trees)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "trees": [
    ],
  • "options": { }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "2 golden config trees imported successfully"
}

Remove Tasks from Node

Remove Tasks from a node in a Golden Config tree

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
nodePath
string (configuration_manager_goldenConfigData_goldenConfigNodePath)
tasks
Array of strings (tasks)

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Golden Config node updated"
}

Add Tasks to Node

Add Tasks to a node in a Golden Config tree

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
nodePath
string (configuration_manager_goldenConfigData_goldenConfigNodePath)
tasks
Array of strings (tasks)

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Golden Config node updated"
}

Add Devices to Node

Add devices to a node in a Golden Config tree

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

version
required
string (goldenConfigTreeVersionName)
Examples: initial v2 v3 draft-v4

version

nodePath
required
string (goldenConfigNodePath)
Examples: base base/US East base/US East/Atlanta

nodePath

Request Body schema: application/json

request body

devices
Array of strings (devices)

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Golden Config node updated"
}

Remove Devices from Node

Remove devices from a node in a Golden Config tree

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

version
required
string (goldenConfigTreeVersionName)
Examples: initial v2 v3 draft-v4

version

nodePath
required
string (goldenConfigNodePath)
Examples: base base/US East base/US East/Atlanta

nodePath

Request Body schema: application/json

request body

devices
Array of strings (devices)

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Golden Config node updated"
}

Create a new node in a Golden Config tree.

Create a new node in the specified Golden Config tree.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

version
required
string (goldenConfigTreeVersionName)
Examples: initial v2 v3 draft-v4

version

parentNodePath
required
string (parentNodePath)
Examples: base/US East

parentNodePath

Request Body schema: application/json

request body

name
string (name)

Responses

Request samples

Content type
application/json
{
  • "name": "DC"
}

Response samples

Content type
application/json
{
  • "name": "base",
  • "attributes": {
    },
  • "children": [
    ]
}

Update properties of a node in a Golden Config tree.

Update properties of the specified Golden Config node.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

version
required
string (goldenConfigTreeVersionName)
Examples: initial v2 v3 draft-v4

version

nodePath
required
string (goldenConfigNodePath)
Examples: base base/US East base/US East/Atlanta

nodePath

Request Body schema: application/json

request body

name
string (name)
object (attributes)

Responses

Request samples

Content type
application/json
{
  • "name": "Southeast",
  • "attributes": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Golden Config node updated"
}

Delete a node in a Golden Config tree.

Permanently delete the specified node in the Golden Config tree. Not reversible.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

version
required
string (goldenConfigTreeVersionName)
Examples: initial v2 v3 draft-v4

version

nodePath
required
string (goldenConfigNodePath)
Examples: base base/US East base/US East/Atlanta

nodePath

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Configuration node deleted"
}

Get a Config Spec document.

Get the details of the specified Config Spec.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

id

Responses

Response samples

Content type
application/json
{
  • "id": "5c35355dbebaa82eaf8113f0",
  • "deviceType": "cisco-ios",
  • "lines": [
    ],
  • "created": "2019-04-12T14:42:47.958Z",
  • "createdBy": "5c35355dbebaa82eaf8113f0",
  • "lastUpdated": "2019-04-12T14:42:47.958Z",
  • "lastUpdatedBy": "5c35355dbebaa82eaf8113f0"
}

Update a Config Spec.

Update content of the Config Spec.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

id

Request Body schema: application/json

request body

object (data)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Config Spec updated"
}

Get a Config Spec template.

Get the template of the specified Config Spec

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
nodePath
string (configuration_manager_goldenConfigData_goldenConfigNodePath)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "options": { }
}

Response samples

Content type
application/json
{
  • "currentTemplate": "string",
  • "inheritedTemplate": "string"
}

Create a new Config Spec.

Create a new Config Spec.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

deviceType
string (deviceType)
object (data)

Responses

Request samples

Content type
application/json
{
  • "deviceType": "cisco-ios",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "id": "5c35355dbebaa82eaf8113f0",
  • "deviceType": "cisco-ios",
  • "lines": [
    ],
  • "created": "2019-04-12T14:42:47.958Z",
  • "createdBy": "5c35355dbebaa82eaf8113f0",
  • "lastUpdated": "2019-04-12T14:42:47.958Z",
  • "lastUpdatedBy": "5c35355dbebaa82eaf8113f0"
}

Update node configuration.

Updates the configuration for a specified node.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
treeVersion
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
nodePath
string (configuration_manager_goldenConfigData_goldenConfigNodePath)
object (data)
updateVariables
boolean (updateVariables)

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "treeVersion": "initial",
  • "nodePath": "base",
  • "data": {
    },
  • "updateVariables": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Node Config updated"
}

Convert a config spec into a readable string.

Converts a object like config into a human-readable config string.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeID
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
nodePath
string (configuration_manager_goldenConfigData_goldenConfigNodePath)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "treeID": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "options": { }
}

Response samples

Content type
application/json
{
  • "config": "interface Loopback01\n description loopback01"
}

Builds a config spec from raw config.

Takes raw native config and builds a configuration spec.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

nativeConfig
string (configuration_manager_deviceData_deviceConfigurationString)
deviceType
string (deviceType)
Enum: "cisco-ios" "cisco-asa" "cisco-ios-xr" "cisco-nx" "cisco-staros" "alu-sr" "a10-acos" "juniper-junos" "f5-bigip" "arista-eos"
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "nativeConfig": "hostname ios0\nno service password-encryption\n...",
  • "deviceType": "cisco-ios",
  • "options": { }
}

Response samples

Content type
application/json
[
  • {
    }
]

Get a JSON Spec document.

Get the details of the specified JSON Spec.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

id

Responses

Response samples

Content type
application/json
{ }

Update a JSON Spec

Update content of the JSON Spec.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

id

Request Body schema: application/json

request body

data
object (data)

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "JSON Spec updated"
}

Get a JSON Spec document with inheritance.

Get the details of the specified JSON Spec with inheritance.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
nodePath
string (configuration_manager_goldenConfigData_goldenConfigNodePath)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "options": { }
}

Response samples

Content type
application/json
{ }

Create a new JSON Spec.

Create a new JSON Spec.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

data
object (data)

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": "5c35355dbebaa82eaf8113f0",
  • "deviceType": "json",
  • "data": { },
  • "created": "2019-04-12T14:42:47.958Z",
  • "createdBy": "5c35355dbebaa82eaf8113f0",
  • "lastUpdated": "2019-04-12T14:42:47.958Z",
  • "lastUpdatedBy": "5c35355dbebaa82eaf8113f0"
}

Run Compliance Reports.

Kick off one or more compliance checks for devices in a specified Golden Config tree.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

deviceName
string (deviceName)
configuration
string (configuration)

Responses

Request samples

Content type
application/json
{
  • "deviceName": "Cisco-Device.1",
  • "configuration": "interface Loopback1\n ip address 10.0.0.1\nntp server 105.62.30.158"
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "compliance batch ${batchId} started",
  • "batchId": "5c35355dbebaa82eaf8113f0"
}

Run Compliance Reports.

Kick off one or more compliance checks for devices in a specified Golden Config tree.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "compliance batch ${batchId} started",
  • "batchId": "5c35355dbebaa82eaf8113f0"
}

Run Compliance Reports on Backups.

Kick off one or more compliance checks for backups in a specified Golden Config tree.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (treeInfo)
backupIds
Array of strings (backupIds)
object (options)

Responses

Request samples

Content type
application/json
{
  • "treeInfo": {
    },
  • "backupIds": [
    ],
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "compliance batch ${batchId} started",
  • "batchId": "5c35355dbebaa82eaf8113f0"
}

Summarize Compliance Reports for a Tree.

Summarize Compliance Reports for a Tree.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

Responses

Response samples

Content type
application/json
{
  • "errors": 0,
  • "warnings": 0,
  • "passes": 0,
  • "infos": 0,
  • "deviceWithErrors": 0,
  • "deviceWithWarnings": 0,
  • "deviceWithInfos": 0,
  • "fullyCompliantDevices": 0,
  • "numDevices": 0
}

Summarize Compliance Reports for a Node.

Summarize Compliance Reports for a Node.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
treeId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

treeId

nodePath
required
string (goldenConfigNodePath)
Examples: base base/US East base/US East/Atlanta

nodePath

Responses

Response samples

Content type
application/json
{
  • "errors": 0,
  • "warnings": 0,
  • "passes": 0,
  • "infos": 0,
  • "deviceWithErrors": 0,
  • "deviceWithWarnings": 0,
  • "deviceWithInfos": 0,
  • "fullyCompliantDevices": 0,
  • "numDevices": 0
}

Get graded compliance reports for a node.

Get a set of graded and scored compliance reports for a node.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
object (options)

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "options": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Grade Report

Get graded compliance report

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

reportId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
object (configuration_manager_goldenConfigData_reportGradingOptions)

Responses

Request samples

Content type
application/json
{
  • "reportId": "5c35355dbebaa82eaf8113f0",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "id": "5c35355dbebaa82eaf8113f0",
  • "batchId": "5c35355dbebaa82eaf8113f0",
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "deviceType": "cisco-ios",
  • "specId": "5c35355dbebaa82eaf8113f0",
  • "inheritedSpecIds": [
    ],
  • "deviceName": "xr9kv-atl",
  • "variables": [
    ],
  • "timestamp": "2019-04-12T14:42:47.958Z",
  • "totals": {
    },
  • "issues": [
    ],
  • "score": 0,
  • "grade": "pass"
}

Get historical graded compliance reports.

Get historical graded compliance reports for a device on a node.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
nodePath
string (configuration_manager_goldenConfigData_goldenConfigNodePath)
deviceName
string (configuration_manager_deviceData_deviceName)
object (configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions)

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "deviceName": "xr9kv-atl",
  • "options": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Get historical graded compliance reports.

Get historical graded compliance reports for a task instance on a node.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
nodePath
string (configuration_manager_goldenConfigData_goldenConfigNodePath)
taskId
string (taskId)
object (configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions)

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "taskId": "5f80bd24f8479975bb46054d",
  • "options": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Get historical graded compliance reports with pagination support.

Get historical graded compliance reports for a device on a node with pagination support.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

treeId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
version
string (configuration_manager_goldenConfigData_goldenConfigTreeVersionName)
nodePath
string (configuration_manager_goldenConfigData_goldenConfigNodePath)
object (filter)
object (configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions)

Responses

Request samples

Content type
application/json
{
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "filter": {
    },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "history": [
    ]
}

Get compliance report metadata for a batch.

Get compliance report metadata by batch ID.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
batchId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

batchId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get compliance report metadata for a batch.

Get compliance report metadata by batch ID.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
batchId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

batchId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Compliance Reports totals for a Device.

Compliance Reports totals for a Device.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Compliance Reports totals for a Backup.

Compliance Reports totals for a Backup.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Compliance Reports totals for a Task Instance.

Compliance Reports totals for a Task Instance.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Compliance Report

Get the details of a particular compliance report

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
reportId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

reportId

Responses

Response samples

Content type
application/json
{
  • "id": "5c35355dbebaa82eaf8113f0",
  • "batchId": "5c35355dbebaa82eaf8113f0",
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "deviceType": "cisco-ios",
  • "specId": "5c35355dbebaa82eaf8113f0",
  • "inheritedSpecIds": [
    ],
  • "deviceName": "xr9kv-atl",
  • "variables": [
    ],
  • "timestamp": "2019-04-12T14:42:47.958Z",
  • "totals": {
    },
  • "issues": [
    ],
  • "score": 0
}

Get JSON Compliance Report

Get the details of a particular JSON compliance report

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
reportId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

reportId

Responses

Response samples

Content type
application/json
{
  • "id": "5c35355dbebaa82eaf8113f0",
  • "batchId": "5c35355dbebaa82eaf8113f0",
  • "treeId": "5c35355dbebaa82eaf8113f0",
  • "version": "initial",
  • "nodePath": "base",
  • "deviceType": "cisco-ios",
  • "specId": "5c35355dbebaa82eaf8113f0",
  • "inheritedSpecIds": [
    ],
  • "deviceName": "xr9kv-atl",
  • "variables": [
    ],
  • "timestamp": "2019-04-12T14:42:47.958Z",
  • "totals": {
    },
  • "issues": [
    ],
  • "score": 0
}

Get details of a particular set of compliance checks.

Get details of a particular set of compliance checks.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

reportIds
Array of strings (reportIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "reportIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the top issues from compliance reports

Get the top most offending issues from all latest compliance reports

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the top issues from JSON compliance reports

Get the top most offending issues from all latest JSON compliance reports

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
[
  • { }
]

Alters a device configuration

Apply specified changes to a device configuration

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
deviceName
required
string (name)
Examples: xr9kv-atl

deviceName

Request Body schema: application/json

request body

Array of objects (changes)

Responses

Request samples

Content type
application/json
{
  • "changes": [
    ]
}

Response samples

Content type
application/json
{
  • "response": [
    ]
}

Alters a device configuration

Apply specified changes to a device configuration with additional options

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
deviceName
required
string (name)
Examples: xr9kv-atl

deviceName

Request Body schema: application/json

request body

Array of objects (changes)
object (options)

Responses

Request samples

Content type
application/json
{
  • "changes": [
    ],
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "response": [
    ]
}

Converts patch data to native config.

Converts the config patch data into a readable native config.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

deviceType
string (deviceType)
Array of objects (changes)

Responses

Request samples

Content type
application/json
{
  • "deviceType": "cisco-ios",
  • "changes": [
    ]
}

Response samples

Content type
application/json
{
  • "config": "interface Loopback01\n description loopback01",
  • "changes": [
    ]
}

Call Adapter Method

Perform south bound specific logic via direct adapter call(s)

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
device
required
string (name)
Examples: xr9kv-atl

device name

origin
required
string (origin)
Examples: nso46 ansible-us

origin name

action
required
string (action)
Examples: checkSync

adapter action/function to be called

Responses

Response samples

Content type
application/json
{ }

Creates a device template

Creates a new device template in pronghorn

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

name
string (name)
template
string (template)
variables
object (variables)
object (options)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "template": "interface Loopback1\n description {{ description }}",
  • "variables": { },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "data": {
    }
}

Updates a device template

Updates a new device template in pronghorn

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

id
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
object (data)
object (options)

Responses

Request samples

Content type
application/json
{
  • "id": "5c35355dbebaa82eaf8113f0",
  • "data": {
    },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "updated": 2
}

Delete one or more device template(s) by Id

This API call will delete device templates based on given Ids

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

templateIds
Array of strings (templateIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "templateIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "deleted": 0
}

Gets a device template

Gets a new device template in pronghorn

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

name
string (name)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "options": { }
}

Response samples

Content type
application/json
{
  • "total": 1,
  • "list": [
    ]
}

Import device config template documents

Insert device config template documents into the device_templates collection

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

templates
Array of any (templates)

Responses

Request samples

Content type
application/json
{
  • "templates": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "2 device template imported successfully"
}

Apply a device config

This API call will apply a configuration to a specified device

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
deviceName
required
string (name)
Examples: xr9kv-atl

Device name

Request Body schema: application/json

request body

object (configuration_manager_deviceData_deviceConfiguration)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "options": { }
}

Response samples

Content type
application/json
{ }

Apply a device config template

This API call will apply a configuration template to a specified device

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

deviceName
string (configuration_manager_deviceData_deviceName)
templateId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "deviceName": "xr9kv-atl",
  • "templateId": "5c35355dbebaa82eaf8113f0",
  • "options": { }
}

Response samples

Content type
application/json
{ }

Get operational data for a device Deprecated

Gets all the operational data for the specified device

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
deviceName
required
string (name)
Examples: xr9kv-atl

Device name

Request Body schema: application/json

request body

object (options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{ }

Import compliance plan documents

Insert compliance plan documents into the ucm_compliance_plans collection

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

Array of objects (plans)

Responses

Request samples

Content type
application/json
{
  • "plans": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "2 compliance plan(s) imported successfully."
}

Creates a compliance plan

Creates a compliance plan which can be used to execute compliance reports

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

name
string (name)
object (options)

Responses

Request samples

Content type
application/json
{
  • "name": "Firewall Policies",
  • "options": {
    }
}

Response samples

Content type
application/json
{ }

Updates a compliance plan

Updates a compliance plan that already exists

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

planId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
object (options)

Responses

Request samples

Content type
application/json
{
  • "planId": "5c35355dbebaa82eaf8113f0",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Compliance Plan updated"
}

Delete compliance plans

Delete the specified compliance plans

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

planIds
Array of strings (planIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "planIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "deleted": 0
}

Fetches a compliance plan

Fetches a compliance plan with the provided ID

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
planId
required
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Examples: 5c35355dbebaa82eaf8113f0

planId

Responses

Response samples

Content type
application/json
{ }

Search all Compliance Plans

Gets a list of all Compliance Plans that match the search criteria

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

name
string (name)
object (options)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "groups": [
    ]
}

Search all Compliance Plan instances

Gets a list of all Compliance Plan Instances that match the search criteria

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

searchParams (object) or searchParams (object) or searchParams (object) (searchParams)

Responses

Request samples

Content type
application/json
{
  • "searchParams": {
    }
}

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "groups": [
    ]
}

Adds node(s) to a compliance plan

Adds new node(s) to an already existing compliance plan

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

planId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
Array of objects (nodes)
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "planId": "5c35355dbebaa82eaf8113f0",
  • "nodes": [
    ],
  • "options": { }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Successfully added node(s) to compliance plan"
}

Removes node(s) from a compliance plan

Removes new node(s) from an already existing compliance plan

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

planId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
nodeIds
Array of strings (nodeIds) [ items^[0-9a-f]{24}$ ]
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "planId": "5c35355dbebaa82eaf8113f0",
  • "nodeIds": [
    ],
  • "options": { }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Successfully added node(s) to compliance plan"
}

Runs a compliance plan

This API call will create WF job that will execute the compliance plan

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

planId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
options
object (options)

Responses

Request samples

Content type
application/json
{
  • "planId": "5c35355dbebaa82eaf8113f0",
  • "options": { }
}

Response samples

Content type
application/json
{ }

Update properties of a compliance plan instance

Update properties of the specified compliance plan instance

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

planId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
instanceId
string (configuration_manager_common_mongoObjectId) ^[0-9a-f]{24}$
object (options)

Responses

Request samples

Content type
application/json
{
  • "planId": "5c35355dbebaa82eaf8113f0",
  • "instanceId": "5c35355dbebaa82eaf8113f0",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Compliance Run Report updated"
}

Customization

Get banner.

Get banner for customization

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Update the banner.

Update the banner

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

updates

_id
string^[0-9a-f]{24}$

String representation of a MongoDB ObjectId

active
required
boolean

A flag indicating if the banner will be displayed to users

text
required
string

Text in the banner when displayed

backgroundColor
string

The background color for the banner displayed

dismissible
required
boolean

A flag indicating if a banner should be dismissible by users

startTime
required
string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$

An ISO Timestring value indicating when the banner will show

endTime
string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$

A, ISO Timestring value indicating when the banner will no longer show

allPages
required
boolean

A flag indicating if the banner should show on all pages or only the IAP home page

image
string

A base64 image string containing the image that will be shown on the banner

messageLastUpdated
string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$

An ISO Timestring value indicating when the banner message was last updated

Responses

Request samples

Content type
application/json
{
  • "_id": "5cb7b531d06cceb89fd21b1c",
  • "active": true,
  • "text": "string",
  • "backgroundColor": "#fff",
  • "dismissible": true,
  • "startTime": "2018-08-02T15:56:12.912Z",
  • "endTime": "2018-08-02T15:56:12.912Z",
  • "allPages": true,
  • "image": "string",
  • "messageLastUpdated": "2018-08-02T15:56:12.912Z"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Device Counts

Get device count history

Get device count history

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

order
string
Default: "newest"
Enum: "newest" "oldest"

order

serverId
string

The server ID where the device counts came from

before
integer

The timestamp in milliseconds used as an upper range. Should be higher than the after value.

after
integer

The timestamp in milliseconds used as a lower range. Should be lower than the after value.

Responses

Response samples

Content type
application/json
{
  • "results": {
    },
  • "total": 1
}

Refresh device count history

Refresh device count history

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
null

Git

Retrieve a project from Git

Retrieve a project from Git

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
gitType
required
string (iap_git-common_type)
Enum: "GitHub" "GitLab"

The name of the Git provider that is used

repoPath
required
string (repoPath)
Examples: github-organization gitlabGroup%2FsubGroup

The path in Git to the repository

branchName
required
string (branchName)
Examples: main

The name of the branch that is used.

projectPath
required
string (repoPath)
Examples: directory%2Fproject.json example.json

The file path within a Git repository to a project file

Responses

Response samples

Content type
application/json
{ }

Initialize a project in Git

Initialize a project in Git

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
gitType
required
string (iap_git-common_type)
Enum: "GitHub" "GitLab"

The name of the Git provider that is used

repoPath
required
string (repoPath)
Examples: github-organization gitlabGroup%2FsubGroup

The path in Git to the repository

branchName
required
string (branchName)
Examples: main

The name of the branch that is used.

projectPath
required
string (repoPath)
Examples: directory%2Fproject.json example.json

The file path within a Git repository to a project file

project
required
object (project)

The project document being pushed to Git

Request Body schema: application/json

request body

commitMessage
string (iap_git-common_commitMessage)

The commit message sent to Git when updating a project

Responses

Request samples

Content type
application/json
{
  • "commitMessage": "This is an example commit message."
}

Response samples

Content type
application/json
{
  • "message": "Successfully initialized project",
  • "data": { }
}

Update a project in Git

Update a project in Git

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
gitType
required
string (iap_git-common_type)
Enum: "GitHub" "GitLab"

The name of the Git provider that is used

repoPath
required
string (repoPath)
Examples: github-organization gitlabGroup%2FsubGroup

The path in Git to the repository

branchName
required
string (branchName)
Examples: main

The name of the branch that is used.

projectPath
required
string (repoPath)
Examples: directory%2Fproject.json example.json

The file path within a Git repository to a project file

project
required
object (project)

The project document being pushed to Git

Request Body schema: application/json

request body

commitMessage
string (iap_git-common_commitMessage)

The commit message sent to Git when updating a project

Responses

Request samples

Content type
application/json
{
  • "commitMessage": "This is an example commit message."
}

Response samples

Content type
application/json
{
  • "message": "Successfully updated project",
  • "data": { }
}

Create a new branch in a repository

Create a new branch in a repository

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
gitType
required
string (iap_git-common_type)
Enum: "GitHub" "GitLab"

The name of the Git provider that is used

repoPath
required
string (repoPath)
Examples: github-organization gitlabGroup%2FsubGroup

The path in Git to the repository

Request Body schema: application/json

request body

originBranch
string (iap_git-common_branchName)

The name of the branch inside a Git repository

newBranch
string (iap_git-common_branchName)

The name of the branch inside a Git repository

Responses

Request samples

Content type
application/json
{
  • "originBranch": "main",
  • "newBranch": "main"
}

Response samples

Content type
application/json
{
  • "message": "Successfully created branch: exampleBranch"
}

List the available branches for a repository

List the available branches for a repository

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
gitType
required
string (iap_git-common_type)
Enum: "GitHub" "GitLab"

The name of the Git provider that is used

repoPath
required
string (repoPath)
Examples: github-organization gitlabGroup%2FsubGroup

The path in Git to the repository

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new repository in Git for storing projects

Create a new repository in Git for storing projects

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
gitType
required
string (iap_git-common_type)
Enum: "GitHub" "GitLab"

The name of the Git provider that is used

repoPath
required
string (repoPath)
Examples: github-organization gitlabGroup%2FsubGroup

The path in Git to the repository

Request Body schema: application/json

request body

repoName
string (repoName)

Responses

Request samples

Content type
application/json
{
  • "repoName": "RepositoryName"
}

Response samples

Content type
application/json
{
  • "message": "`Successfully created repository: ExampleRepo",
  • "data": {
    }
}

Group Mappings

Get all group mappings.

Get all group mappings

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
multiContains
object

multiContains

multiEquals
object

multiEquals

multiStartsWith
object

multiStartsWith

expand
string (List of fields to get expanded data)
Examples: expand=iapGroups

Sets the fields to expand

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

Responses

Response samples

Content type
application/json
{
  • "results": {
    },
  • "total": 1
}

Create a group mapping.

Create a group mapping

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (iap_mapping-schema)

This is the schema for an IAP group mapping stored in Mongo

Responses

Request samples

Content type
application/json
{
  • "groupMapping": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Get an individual group mapping.

Get an individual group mapping

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
provenance
required
string (provenance)

The provenance for the requested group mapping.

externalGroup
required
string (externalGroup)

The name of the external group that is mapped.

Responses

Response samples

Content type
application/json
{
  • "externalGroup": "string",
  • "provenance": "Okta",
  • "iapGroups": [
    ]
}

Update a group mapping.

Update a group mapping

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
provenance
required
string (provenance)

The provenance for the requested group mapping.

externalGroup
required
string (externalGroup)

The individual group mapping to update.

Request Body schema: application/json

request body

object (updates)

Responses

Request samples

Content type
application/json
{
  • "updates": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Delete a group mapping.

Delete a group mapping

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
provenance
required
string (provenance)

The provenance for the requested group mapping.

externalGroup
required
string (externalGroup)

The individual group mapping to delete.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Health

Get the health of a single adapter.

Get the health of a single adapter in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name for the selected adapter.

Responses

Response samples

Content type
application/json
{
  • "id": "AdminEssentials",
  • "package_id": "@itential/adapter-local_aaa",
  • "version": "0.0.1",
  • "type": "Adapter",
  • "description": "A basic description",
  • "state": "DEAD",
  • "connection": { },
  • "uptime": 2245.9722,
  • "memoryUsage": {
    },
  • "cpuUsage": {
    },
  • "pid": 7125982,
  • "logger": {
    },
  • "routePrefix": "admin",
  • "prevUptime": 2245.9722
}

Get the health of a single application.

Get the health of a single application in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name for the selected application.

Responses

Response samples

Content type
application/json
{
  • "id": "AdminEssentials",
  • "package_id": "@itential/adapter-local_aaa",
  • "version": "0.0.1",
  • "type": "Adapter",
  • "description": "A basic description",
  • "state": "DEAD",
  • "connection": { },
  • "uptime": 2245.9722,
  • "memoryUsage": {
    },
  • "cpuUsage": {
    },
  • "pid": 7125982,
  • "logger": {
    },
  • "routePrefix": "admin",
  • "prevUptime": 2245.9722
}

Get the health of all the adapters.

Get the health of all the adapters in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
contains
string
Examples: contains=redis

contains

containsField
string
Examples: containsField=name

containsField

equals
string
Examples: equals=redis

equals

equalsField
string
Examples: equalsField=name

equalsField

startsWith
string
Examples: startsWith=redis

startsWith

startsWithField
string
Examples: startsWithField=name

startsWithField

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": 1
}

Get the health of all the applications.

Get the health of all the applications in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
contains
string
Examples: contains=redis

contains

containsField
string
Examples: containsField=name

containsField

equals
string
Examples: equals=redis

equals

equalsField
string
Examples: equalsField=name

equalsField

startsWith
string
Examples: startsWith=redis

startsWith

startsWithField
string
Examples: startsWithField=name

startsWithField

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": 1
}

Get the health of the server.

Get the health of the server.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{
  • "version": "0.0.1",
  • "release": "0.0.1",
  • "arch": "arm",
  • "platform": "aix",
  • "versions": {
    },
  • "memoryUsage": {
    },
  • "cpuUsage": {
    },
  • "uptime": 2245.9722,
  • "pid": 7125982,
  • "dependencies": {
    }
}

Get the health of the system.

Get the health of the system.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{
  • "arch": "x64",
  • "release": "0.0.1",
  • "uptime": 12539,
  • "freemem": 14377422848,
  • "totalmem": 34359738368,
  • "loadavg": [
    ],
  • "cpus": [
    ]
}

Get status.

Get status of current IAP.

Responses

Response samples

Content type
application/json
{
  • "host": "string",
  • "serverId": "string",
  • "services": [
    ],
  • "timestamp": 0,
  • "apps": "running",
  • "adapters": "running"
}

Help

Documentation Help

Generate documentation for adapters

Generate an HTML documentation page for adapters

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
"string"

Generate documentation for brokers

Generate an HTML documentation page for brokers

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
"string"

Generate documentation for applications

Generate an HTML documentation page for applications

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
"string"

Generate an OpenAPI v3 document for IAP

Generate an OpenAPI v3.1.0 document for IAP

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
url
string
Examples: url=http://localhost:3000

url

Responses

Response samples

Content type
application/json
{ }

Indexes

Get all pre-defined indexes.

Get all pre-defined indexes to be used in Mongo.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
application
string
Examples: application=@itential/app-workflow_engine

application

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Check the status of a collection's indexes in Mongo

Check the status of pre-defined indexes for a specific collection.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
collection
required
string (collection)

The name of a collection in Mongo.

Responses

Response samples

Content type
application/json
{
  • "missing": [
    ],
  • "misnamed": [
    ],
  • "external": [
    ],
  • "indexed": 0,
  • "total": 1,
  • "collectionSize": 0,
  • "inProgress": true
}

Check the status of multiple collections' indexes in Mongo

Check the status of pre-defined indexes for multiple collections.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
Array of strings or string

collections

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Create a collection's indexes in Mongo

Create all pre-defined indexes for a specific collection.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
collection
required
string (collection)

The name of a collection in Mongo.

Responses

Response samples

Content type
application/json
{
  • "unchanged": 0,
  • "changed": 0,
  • "total": 1,
  • "running": true
}

Integration Models

Create a new integration model.

Create a new integration model in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

model
any (model)

Refer to OpenAPI specifications for the structure of an OpenAPI document.

Responses

Request samples

Content type
application/json
{
  • "model": null
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": { }
}

Get all integration models.

Get all the integration models in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
contains
string
Examples: contains=git contains=hub contains=v5

Filter the response based on each item that includes the provided query.

containsField
string
Value: "versionId"

containsField

equals
string
Examples: equals=GitHub:v5

Filter the response based on each item that is an exact match to the provided query.

equalsField
string
Value: "versionId"

equalsField

startsWith
string
Examples: startsWith=g

Filter the response based on each item that starts with the provided query.

startsWithField
string
Value: "versionId"

startsWithField

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string
Value: "versionId"

Field to sort by. Default is versionId.

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

Responses

Response samples

Content type
application/json
{
  • "integrationModels": {
    },
  • "total": 1
}

Update an integration model.

Update an integration model in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

model
any (model)

Refer to OpenAPI specifications for the structure of an OpenAPI document.

Responses

Request samples

Content type
application/json
{
  • "model": null
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": { }
}

Delete an integration model.

Delete an integration model from IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: GitHub:v5

The name of the integration model.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Get a specific integration model.

Get a specific integration model in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: Gitlab:v5

The name of the integration model.

Responses

Response samples

Content type
application/json
{
  • "model": "@itential/adapter_GitHub:v5",
  • "versionId": "GitHub:v5",
  • "description": "A standard description about the integration model",
  • "properties": { }
}

Export an integration model.

Export an integration model's open API spec.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: GitHub:v5

The name of the integration model.

Responses

Response samples

Content type
application/json
{ }

Gets an integration model's security schemes.

Projection simplification for exportIntegrationModel

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: GitHub:v5

The name of the integration model.

Responses

Response samples

Content type
application/json
{ }

Validate an integration model.

Validate an integration model.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

model
any (model)

Refer to OpenAPI specifications for the structure of an OpenAPI document.

Responses

Request samples

Content type
application/json
{
  • "model": null
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "string"
}

Integrations

Create a new integration.

Create a new integration in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Get all integrations.

Get all integrations in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
contains
string
Examples: contains=GitHub

contains

containsField
string
Examples: containsField=name

containsField

equals
string
Examples: equals=GitHub

equals

equalsField
string
Examples: equalsField=name

equalsField

startsWith
string
Examples: startsWith=GitHub

startsWith

startsWithField
string
Examples: startsWithField=name

startsWithField

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

skipActiveSync
boolean
Default: false

skipActiveSync

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": 1
}

Delete an integration.

Delete an integration from IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected integration.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Get a single integration.

Get a single integration in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected integration.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "data": {
    }
}

Update an integration.

Update an integration in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

Contains the name for the selected integration.

Request Body schema: application/json

request body

object (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Posts an access token with an Authorization Code

Initiates the Authorization Code exchange for an access token and stores the change

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name of the selected integration.

Request Body schema: application/json

request body

authorizationCode
string (authorizationCode)
redirectUri
string (redirectUri)

Responses

Request samples

Content type
application/json
{
  • "authorizationCode": "string",
  • "redirectUri": "string"
}

Response samples

Content type
application/json
{ }

Update the properties of an integration.

Update the properties of an integration in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (Name) ^[^\/]+$
Default: ""
Examples: Local AAA

The name for the selected integration.

Request Body schema: application/json

request body

properties
any (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": null
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

JSON Forms

An application to create, edit, and publish forms based on JSON documents.

Creates a Json Form

Creates a new JSON form document with a unique name.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

name
string (name)
description
string (description)
object (json-forms_formStruct)
object (json-forms_formSchema_container)
object (json-forms_formUISchema_container)
bindingSchema
object (json-forms_formBindingSchema_bindingSchema)
validationSchema
object (json-forms_formValidationSchema_validationSchema)

Responses

Request samples

Content type
application/json
{
  • "name": "Device Form",
  • "description": "This form describes the connection information for a device.",
  • "struct": {
    },
  • "schema": {
    },
  • "uiSchema": { },
  • "bindingSchema": { },
  • "validationSchema": { }
}

Response samples

Content type
application/json
{
  • "_id": "5cb5252a1bbc5a00def564c1",
  • "created": "2019-04-16T00:43:22.038Z",
  • "createdBy": "5cb08d4f16640f00182c3890",
  • "lastUpdated": "2019-04-16T00:43:22.038Z",
  • "lastUpdatedBy": "5cb08d4f16640f00182c3890",
  • "name": "Device Form",
  • "tags": [
    ],
  • "description": "This form describes the connection information for a device.",
  • "struct": {
    },
  • "schema": {
    },
  • "uiSchema": { },
  • "validationSchema": { },
  • "bindingSchema": { },
  • "version": "2020.1",
  • "id": "5cb5252a1bbc5a00def564c1",
  • "namespace": { }
}

Returns all forms

Returns all JSON form documents that have previously been created.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes a forms

Delete a list of JSON Forms from IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

ids
Array of strings (ids)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "n": 0
}

Finds a form

Finds a previously created JSON form, based on a supplied document ID.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (json-forms_formDocument_formId)
Examples: 5cb5252a1bbc5a00def564c1

Unique name of the form

Responses

Response samples

Content type
application/json
{
  • "_id": "5cb5252a1bbc5a00def564c1",
  • "created": "2019-04-16T00:43:22.038Z",
  • "createdBy": "5cb08d4f16640f00182c3890",
  • "lastUpdated": "2019-04-16T00:43:22.038Z",
  • "lastUpdatedBy": "5cb08d4f16640f00182c3890",
  • "name": "Device Form",
  • "tags": [
    ],
  • "description": "This form describes the connection information for a device.",
  • "struct": {
    },
  • "schema": {
    },
  • "uiSchema": { },
  • "validationSchema": { },
  • "bindingSchema": { },
  • "version": "2020.1",
  • "id": "5cb5252a1bbc5a00def564c1",
  • "namespace": { }
}

Updates a form

Updates a previously created JSON form, based on a supplied document ID and an object of fields to update.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (json-forms_formDocument_formId)
Examples: 5cb5252a1bbc5a00def564c1

The ID of the form.

Request Body schema: application/json

request body

object (json-forms_formDocument_form)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Form updated"
}

Import form documents

Insert form documents into the forms collection from a user supplied JSON document.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

Array of objects (forms)

Responses

Request samples

Content type
application/json
{
  • "forms": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "2 forms imported successfully",
  • "imported": [
    ]
}

Validates form data against its schema

Retrieves the JSON schema for a given form ID and validates the supplied form data again it.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (json-forms_formDocument_formId)
Examples: 5cb5252a1bbc5a00def564c1

Unique ID of the form

Request Body schema: application/json

request body

object (json-forms_formDocument_formData)

Responses

Request samples

Content type
application/json
{
  • "formData": { }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "validation": {
    },
  • "message": "Form data is valid."
}

Validates data against a schema.

Performs data validation, given a JSON schema and form data.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

boolean or object (json-forms_metaSchema)
object (json-forms_formDocument_formData)

Responses

Request samples

Content type
application/json
{
  • "jsonSchema": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "validation": {
    },
  • "message": "Form data is valid."
}

Converts YANG to JSON Schema.

onverts a list of YANG inputs into JSON Schemas

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

yangData
Array of strings (yang)

Responses

Request samples

Content type
application/json
{
  • "yangData": [
    ]
}

Response samples

Content type
application/json
[
  • { }
]

Decodes an encoded JSON Schema.

Decodes an encoded JSON Schema.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

jsonSchema
object (jsonSchema)

Responses

Request samples

Content type
application/json
{
  • "jsonSchema": { }
}

Response samples

Content type
application/json
{ }

Lifecycle Manager

Cancels an action execution

Cancels an action execution, if targeting a bulk action execution, all its child executions will also be canceled.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
executionId
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

executionId

Responses

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": {
    },
  • "metadata": {
    }
}

Creates a new instance group

Creates a new instance group

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
required
lifecycle-manager_common_ObjectIdLikeString (string) or lifecycle-manager_common_name (string) (modelIdentifier)

modelIdentifier

Request Body schema: application/json

instanceGroup

One of
name
required
string non-empty

The name of the document

description
string

The description of the document

modelId
required
string^[0-9a-f]{24}$

A string which is formatted like an ObjectId, Distinct from an actual ObjectId.

type
any
Value: "manual"
instances
Array of strings[ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "name": "myCoolDocumentName",
  • "description": "Some helpful information about the document",
  • "modelId": "string",
  • "type": "dynamic",
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": {
    },
  • "metadata": {
    }
}

Gets multiple instance groups

Gets multiple instance groups

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
required
lifecycle-manager_common_ObjectIdLikeString (string) or lifecycle-manager_common_name (string) (modelIdentifier)

modelIdentifier

Responses

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": [
    ],
  • "metadata": {
    }
}

Creates a new resource model

Creates a new resource model

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

resourceModelData

name
required
string

The name of the resource model

description
string
Default: ""

Free-form text describing the resource model

schema
any

A draft-07 JSON Schema which defines the validation applied to instances of the resource model

Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "VLAN Service",
  • "description": "This resource model represents something we use on a day-to-day basis.",
  • "schema": null,
  • "actions": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": {
    },
  • "metadata": {
    }
}

Searches resource models

Searches resource models

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": [
    ],
  • "metadata": {
    }
}

Deletes an instance group

Deletes an instance group

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
required
lifecycle-manager_common_ObjectIdLikeString (string) or lifecycle-manager_common_name (string) (modelIdentifier)

modelIdentifier

required
lifecycle-manager_common_ObjectIdLikeString (string) or lifecycle-manager_common_name (string) (groupIdentifier)

groupIdentifier

Responses

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": "null",
  • "metadata": {
    }
}

Gets a single instance group

Gets a single new instance group

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
required
lifecycle-manager_common_ObjectIdLikeString (string) or lifecycle-manager_common_name (string) (modelIdentifier)

modelIdentifier

required
lifecycle-manager_common_ObjectIdLikeString (string) or lifecycle-manager_common_name (string) (groupIdentifier)

groupIdentifier

Responses

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": {
    },
  • "metadata": {
    }
}

Updates a instance group

Updates a instance group

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
required
lifecycle-manager_common_ObjectIdLikeString (string) or lifecycle-manager_common_name (string) (modelIdentifier)

modelIdentifier

required
lifecycle-manager_common_ObjectIdLikeString (string) or lifecycle-manager_common_name (string) (groupIdentifier)

groupIdentifier

Request Body schema: application/json

updates

One of
name
string non-empty

The name of the document

description
string

The description of the document

modelId
string^[0-9a-f]{24}$

A string which is formatted like an ObjectId, Distinct from an actual ObjectId.

type
any
Value: "manual"
instances
Array of strings[ items^[0-9a-f]{24}$ ]
Array of strings or strings
Array of strings or strings

Responses

Request samples

Content type
application/json
{
  • "name": "myCoolDocumentName",
  • "description": "Some helpful information about the document",
  • "modelId": "string",
  • "type": "dynamic",
  • "filter": {
    },
  • "instancesToAdd": [
    ],
  • "instancesToRemove": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": {
    },
  • "metadata": {
    }
}

Deletes a resource model

A resource model will not be deleted if it has associated instances. To override this behavior and delete the resource model along with any associated instances, set the 'delete-associated-instances' flag to 'true'.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

id

Request Body schema: application/json

request body

object (queryParameters)

Responses

Request samples

Content type
application/json
{
  • "queryParameters": {
    }
}

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": "null",
  • "metadata": {
    }
}

Gets a resource model based on id

Gets a resource model based on id

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

The ObjectId of the resource model

query Parameters
dereference
string

dereference

Responses

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": {
    },
  • "metadata": {
    }
}

Updates a resource model

Updates a resource model

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

id

Request Body schema: application/json

updates

object (updates)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": "null",
  • "metadata": {
    }
}

Performs edits to a resource model

Performs edits to a resource model. This method exists to support specific resource edit activities required by the UI.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
modelId
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

Resource model ID

Request Body schema: application/json

properties

One of
command
required
string
Enum: "generate-action-workflow" "generate-action-pre-transformation" "generate-action-post-transformation"

Edit command to execute

required
lifecycle-manager_resource-model-common_action-identifier (string) or lifecycle-manager_resource-model-common_action (string)

Resource action ID or pending action definition

overwrite
boolean

Tells the component generator to either disregard and overwrite an existing component on the action (when true) or to refuse to generate a new component (when false).

updateAction
boolean

Tells the component generator to either update the action in the database (when true) or to only generate and return the new component (when false)

Responses

Request samples

Content type
application/json
{
  • "command": "generate-action-workflow",
  • "action": "0a2f",
  • "overwrite": true,
  • "updateAction": true
}

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": "null",
  • "metadata": {
    }
}

Exports a resource instance

This method exports a resource instance.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
required
lifecycle-manager_common_ObjectIdLikeString (string) or lifecycle-manager_common_name (string) (modelIdentifier)

modelIdentifier

required
lifecycle-manager_common_ObjectIdLikeString (string) or lifecycle-manager_common_name (string) (instanceIdentifier)

instanceIdentifier

Responses

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": {
    },
  • "metadata": {
    }
}

Exports a resource model

This method exports a resource model.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
modelId
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

modelId

Responses

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": {
    },
  • "metadata": {
    }
}

Gets a single action execution record

Gets a single action execution record

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

id

Responses

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": {
    },
  • "metadata": {
    }
}

Searches resource action history documents

Searches resource action history documents

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": [
    ],
  • "metadata": {
    }
}

Gets a single resource instance

Gets a single resource instance

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
modelId
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

modelId

instanceId
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

The identifier of the resource instance

Responses

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": {
    },
  • "metadata": {
    }
}

Updates the `name` and `description` fields of a resource instance

Updates the name and description fields of a resource instance

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
modelId
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

modelId

instanceId
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

instanceId

Request Body schema: application/json

updates

name
string (lifecycle-manager_resource-instance-common_name)

The name of the resource instance

description
string (lifecycle-manager_resource-instance-common_description)

Free-form text describing the resource instance

Responses

Request samples

Content type
application/json
{
  • "name": "VLAN Service",
  • "description": "EC2 Instance in US-EAST-1 with ID ec2-12345678"
}

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": {
    },
  • "metadata": {
    }
}

Searches resource instances

Searches resource instances

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
modelId
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

modelId

Responses

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": [
    ],
  • "metadata": {
    }
}

Imports an instance into a resource

Imports an instance into a resource

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
required
lifecycle-manager_common_ObjectIdLikeString (string) or lifecycle-manager_common_name (string) (modelIdentifier)

modelIdentifier

Request Body schema: application/json

instance

name
required
string

The name of the resource instance

description
required
string
Default: ""

Free-form text describing the resource instance

created
required
any

An ISO date string denoting when this resource instance was created

createdBy
required
any

The account identifier of the user who created this resource instance

lastUpdated
required
any

An ISO date string denoting when this resource instance was last updated

lastUpdatedBy
required
any

The account identifier of the user who last updated this resource instance

required
object or null

The data for the resource instance

Responses

Request samples

Content type
application/json
{
  • "name": "VLAN Service",
  • "description": "EC2 Instance in US-EAST-1 with ID ec2-12345678",
  • "created": null,
  • "createdBy": null,
  • "lastUpdated": null,
  • "lastUpdatedBy": null,
  • "instanceData": { }
}

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": {
    },
  • "metadata": {
    }
}

Imports a resource model

Imports a resource model

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

importParameters

required
object
overwrite
boolean

Responses

Request samples

Content type
application/json
{
  • "model": {
    },
  • "overwrite": true
}

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": {
    },
  • "metadata": {
    }
}

Runs a resource action

Runs a resource action

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
modelId
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

The ID of the Resource Model to run an action on

Request Body schema: application/json

options

actionId
required
string (lifecycle-manager_resource-model-common_action-identifier) ^[0-9a-fA-F]{4}$

A 4-digit hexadecimal id

string or lifecycle-manager_resource-instance-http (object)
instanceName
string (lifecycle-manager_resource-instance-common_name)

The name of the resource instance

instanceDescription
string (lifecycle-manager_resource-instance-common_description)

Free-form text describing the resource instance

object or null

Responses

Request samples

Content type
application/json
{
  • "actionId": "0a2f",
  • "instance": "string",
  • "instanceName": "VLAN Service",
  • "instanceDescription": "EC2 Instance in US-EAST-1 with ID ec2-12345678",
  • "inputs": { }
}

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": "null",
  • "metadata": {
    }
}

Runs a resource action against multiple instances

Runs a resource action against multiple instances

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
required
lifecycle-manager_resource-model-common_name (string) or MongoDB.ObjectId (string)

The ID of the Resource Model to run an action on.

Request Body schema: application/json

options

actionId
required
string (lifecycle-manager_resource-model-common_action-identifier) ^[0-9a-fA-F]{4}$

A 4-digit hexadecimal id

lifecycle-manager_common_ObjectIdLikeString (string) or lifecycle-manager_common_name (string) (groupIdentifier)
instances
Array of strings (lifecycle-manager_common_name) [ items non-empty ]
object or null
Array of arrays or null

Responses

Request samples

Content type
application/json
{
  • "actionId": "0a2f",
  • "group": "string",
  • "instances": [
    ],
  • "inputs": { },
  • "inputOverrides": [ ]
}

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": "null",
  • "metadata": {
    }
}

Validates the actions defined on a resource model

This method validates the actions on a resource model. Each validation report has an associate severity, and designates whether or not it will prevent the action from saving, prevent the model from running, or both. It accepts pending edits to actions in the optional 'actions' body parameter in order to check for validation issues on unsaved, pending changes to an action

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
modelId
required
string (MongoDB.ObjectId) ^[0-9a-fA-F]{24}$
Examples: 62a1f3d2ebedfc54e6e0065c

Resource model ID

Request Body schema: application/json

properties

Array of objects (lifecycle-manager_resource-model-common_actions)

Responses

Request samples

Content type
application/json
{
  • "actions": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "A server error occurred while processing this request",
  • "data": "null",
  • "metadata": {
    }
}

Command Templates (MOP)

Export Template

Export a single template

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

options
object (options)
type
string (type)
Enum: "templates" "analytics"

Responses

Request samples

Content type
application/json
{
  • "options": {
    },
  • "type": "templates"
}

Response samples

Content type
application/json
Example
{
  • "_id": "ASR1K-MOP",
  • "name": "ASR1K-MOP",
  • "namespace": { },
  • "os": "cisco-ios",
  • "passRule": true,
  • "commands": [
    ],
  • "created": 1508182880981,
  • "createdBy": { },
  • "lastUpdated": 1508182880981,
  • "lastUpdatedBy": { }
}

Import Template

Import a single template

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

mop template (object) or mop analytic template (object)
type
string (type)
Enum: "templates" "analytics"

Responses

Request samples

Content type
application/json
{
  • "template": {
    },
  • "type": "templates"
}

Response samples

Content type
application/json
true

Get All Command Templates

Get all Command Templates.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a Command Template by Name

Get a Command Template by name.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (mop_mopTemplateDoc_name)
Examples: ASR1K-MOP

Name of the Command Template.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an Analytic Template by Name

Get an Analytic Template by name.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (mop_mopAnalyticTemplateDoc_name)
Examples: ASR1K-MOP

Name of the Analytic Template.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get All Analytic Templates

Get all Analytic Templates.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Command Template

Create a Command Template.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (mop_mopTemplateDoc)

A mop template object

Responses

Request samples

Content type
application/json
{
  • "mop": {
    }
}

Response samples

Content type
application/json
{
  • "n": 1,
  • "ok": 1,
  • "nModified": 1
}

Create an Analytic Template

Create an Analytic Template.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (mop_mopAnalyticTemplateDoc)

A mop analytic template object

Responses

Request samples

Content type
application/json
{
  • "template": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "ops": [
    ],
  • "insertedCount": 1,
  • "insertedIds": {
    }
}

Delete a Command Template

Delete a Command Template by ID.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (mop_mopTemplateDoc__id)
Examples: ASR1K-MOP

ID of the template to delete.

Responses

Response samples

Content type
application/json
{
  • "n": 1,
  • "ok": 1,
  • "nModified": 1
}

Delete an Analytic Template

Delete an Analytic Template by ID.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (mop_mopAnalyticTemplateDoc__id)
Examples: ASR1K-MOP

ID of the Analytic Template to delete.

Responses

Response samples

Content type
application/json
{
  • "n": 1,
  • "ok": 1,
  • "nModified": 1
}

Update a Command Template

Update a Command Template by ID.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
mopID
required
string (mop_mopTemplateDoc_name)
Examples: ASR1K-MOP

ID of the Command Template to update.

required
object (mop template)

Command Template to update.

Responses

Response samples

Content type
application/json
{
  • "n": 1,
  • "ok": 1,
  • "nModified": 1
}

Update an Analytic Template

Update an Analytic Template by ID.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
mopID
required
string (mop_mopAnalyticTemplateDoc__id)
Examples: ASR1K-MOP

ID of the Analytic Template to update.

Request Body schema: application/json

request body

object (mop_mopAnalyticTemplateDoc)

A mop analytic template object

Responses

Request samples

Content type
application/json
{
  • "template": {
    }
}

Response samples

Content type
application/json
{
  • "n": 1,
  • "ok": 1,
  • "nModified": 1
}

Run a Command against Devices

Run a command against devices.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

command
string (command)
variables
object (mop_mopTemplateDoc_variables)
devices
Array of strings (mop_mopTemplateDoc_devices)

Responses

Request samples

Content type
application/json
{
  • "command": "show version",
  • "variables": {
    },
  • "devices": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Run a Command against a Device

Run a command against a device.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

command
string (command)
variables
object (mop_mopTemplateDoc_variables)
device
string (mop_mopTemplateDoc_device)

Responses

Request samples

Content type
application/json
{
  • "command": "show version",
  • "variables": {
    },
  • "device": "device1"
}

Response samples

Content type
application/json
{
  • "raw": "show version",
  • "all_pass_flag": true,
  • "evaluated": "show version",
  • "parameters": { },
  • "rules": [
    ],
  • "device": "device1",
  • "response": "version: 10.0.0",
  • "result": true
}

Run Command Template

Run a Command Template against devices.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

template
string (template)
variables
object (mop_mopTemplateDoc_variables)
devices
Array of strings (mop_mopTemplateDoc_devices)

Responses

Request samples

Content type
application/json
{
  • "template": "show version",
  • "variables": {
    },
  • "devices": [
    ]
}

Response samples

Content type
application/json
{
  • "raw": "show version",
  • "all_pass_flag": true,
  • "evaluated": "show version",
  • "parameters": { },
  • "rules": [
    ],
  • "device": "device1",
  • "response": "version: 10.0.0",
  • "result": true
}

Run single command from template

Run a single command from a template on a devices.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

templateId
string (mop_mopTemplateDoc__id)
commandIndex
integer (commandIndex)
variables
object (mop_mopTemplateDoc_variables)
devices
Array of strings (mop_mopTemplateDoc_devices)

Responses

Request samples

Content type
application/json
{
  • "templateId": "ASR1K-MOP",
  • "commandIndex": 0,
  • "variables": {
    },
  • "devices": [
    ]
}

Response samples

Content type
application/json
{
  • "raw": "show version",
  • "all_pass_flag": true,
  • "evaluated": "show version",
  • "parameters": { },
  • "rules": [
    ],
  • "device": "device1",
  • "response": "version: 10.0.0",
  • "result": true
}

MOP Get Boot Flash

Get the boot flash image

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

device
string (mop_mopTemplateDoc_device)

Responses

Request samples

Content type
application/json
{
  • "device": "device1"
}

Response samples

Content type
application/json
"10011011"

MOP Pass Thru

Pass Through to execute direct device commands

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
device
required
string (mop_mopTemplateDoc_device)
Examples: device1

device

Request Body schema: application/json

request body

command
string (command)

Responses

Request samples

Content type
application/json
{
  • "command": "show version"
}

Response samples

Content type
application/json
{ }

Get Filtered Devices

Get the devices with name matching the given options.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (mop_mopTemplateDoc_options)

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Filtered Devices with detailed query results

Get the devices with name matching the given string. Also returns the number of results found and number returned

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
substring
required
string (substring)
Examples: tes

String to filter devices

Responses

Response samples

Content type
application/json
{
  • "num_results": 0,
  • "results": [
    ],
  • "total_results": 0
}

Find the diff of two config strings.

Find the diff of two config strings.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

value_a
string (value_a)
value_b
string (value_b)

Responses

Request samples

Content type
application/json
{
  • "value_a": "any string",
  • "value_b": "other string"
}

Response samples

Content type
application/json
[
  • [
    ]
]

MOP Diff Array Deprecated

Generates a diff for the input. By default, the API call timeout is 5 minutes for the platform. If this API call needs additional time, it can be modified in the Express timeout property. The supported timeout range would be a minimum of 8 minutes for a 2MB payload and a maximum of 32 minutes for a 4MB payload.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

pre
Array of strings (pre)
post
Array of strings (post)

Responses

Request samples

Content type
application/json
{
  • "pre": [
    ],
  • "post": [
    ]
}

Response samples

Content type
application/json
{
  • "onlyPre": { },
  • "diff": { },
  • "onlyPost": { },
  • "analytics": { }
}

Run an Analytics Template

Run an Analytic Template.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (pre)
object (post)
analytic_template_name
string (analytic_template_name)
variables
object (mop_mopTemplateDoc_variables)

Responses

Request samples

Content type
application/json
{
  • "pre": {
    },
  • "post": {
    },
  • "analytic_template_name": "test",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "ASR1K-MOP",
  • "name": "ASR1K-MOP",
  • "namespace": { },
  • "os": "cisco-ios",
  • "passRule": true,
  • "prepostCommands": [
    ],
  • "created": 1508182880981,
  • "createdBy": { },
  • "lastUpdated": 1508182880981,
  • "lastUpdatedBy": { }
}

Run an Analytics Template for Devices

Run an Analytic Template for Devices.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (pre)
object (post)
analytic_template_name
string (analytic_template_name)
variables
object (mop_mopTemplateDoc_variables)

Responses

Request samples

Content type
application/json
{
  • "pre": {
    },
  • "post": {
    },
  • "analytic_template_name": "test",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "ASR1K-MOP",
  • "name": "ASR1K-MOP",
  • "namespace": { },
  • "os": "cisco-ios",
  • "passRule": true,
  • "prepostCommands": [
    ],
  • "created": 1508182880981,
  • "createdBy": { },
  • "lastUpdated": 1508182880981,
  • "lastUpdatedBy": { }
}

Retry a task automatically for x number of attempts with n minute intervals.

Workflow will follow reattempt task's outgoing transition after n minutes of delay.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

job_id
string (job_id)
attemptID
string (attemptID)
minutes
integer (minutes)
attempts
integer (attempts)

Responses

Request samples

Content type
application/json
{
  • "job_id": "test",
  • "attemptID": "test1234",
  • "minutes": 1,
  • "attempts": 2
}

Response samples

Content type
application/json
"Success"

Get Filtered Devices

Get the devices with name matching the given string.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
substring
required
string (substring)
Examples: tes

String to filter devices

Responses

Response samples

Content type
application/json
[
  • "Device 2"
]

OAuth

Create a service account in the database.

Create a service account in the database.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object

Responses

Request samples

Content type
application/json
{
  • "accountData": {
    }
}

Response samples

Content type
application/json
{
  • "client_id": "5cb7b531d06cceb89fd21b1c",
  • "client_secret": "d4c673d6-17f8-4e76-8034-a87820f96618"
}

Get service accounts from the database.

Get service accounts from the database.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
object

multiContains

object

multiEquals

object

multiStartsWith

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": 1
}

Updates a service account in the database.

Updates a service account in the database.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
client_id
required
string (iap_service-accounts-schema_clientId) ^[0-9a-f]{24}$
Examples: 5cb7b531d06cceb89fd21b1c

The clientId for the service account

Request Body schema: application/json

request body

object (updates)

Responses

Request samples

Content type
application/json
{
  • "updates": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Deletes a service account in the database.

Deletes a service account in the database.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
client_id
required
string (iap_service-accounts-schema_clientId) ^[0-9a-f]{24}$
Examples: 5cb7b531d06cceb89fd21b1c

The clientId for the service account

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Regenerates the client_secret and returns the new value

Regenerates the client_secret and returns the new value

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
client_id
required
string (iap_service-accounts-schema_clientId) ^[0-9a-f]{24}$
Examples: 5cb7b531d06cceb89fd21b1c

The clientId for the service account

Responses

Response samples

Content type
application/json
{
  • "client_id": "5cb7b531d06cceb89fd21b1c",
  • "client_secret": "d4c673d6-17f8-4e76-8034-a87820f96618"
}

Retrieve a JWT from a client's credentials

Retrieve a JWT from a client's credentials

Request Body schema: application/x-www-form-urlencoded

request body

client_id
string (iap_service-accounts-schema_clientId) ^[0-9a-f]{24}$

String representation of a MongoDB ObjectId

client_secret
string (iap_service-accounts-schema_clientSecret)

Uuid representation of client secret

grant_type
string
Value: "client_credentials"

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "bearer",
  • "expires_in": 3600
}

Operations Manager

Clone Automation

Clone an Automation.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

automation

id
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

A string which is formatted like an ObjectId, Distinct from an actual ObjectId.

null or operations-manager_common_name (string)

An optional name to use for the clone.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": { }
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": {
    }
}

Create Automation

Create a new Automation.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

automation

name
required
string non-empty

The name of the document

description
string

The description of the document

"workflows" (any) or "ucm_compliance_plans" (any) or "resource_models" (any) or null

The type of component linked to this Automation.

object
string or string or null or "" (any)

The id of the component linked to this Automation.

Responses

Request samples

Content type
application/json
{
  • "name": "Cisco IOS upgrade",
  • "description": "Turn up the port",
  • "componentType": "workflows",
  • "gbac": {
    },
  • "componentId": "string"
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Get Automations

Search the Automation collection.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": [
    ],
  • "metadata": {
    }
}

Import Automations

Import Automations.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

Array of objects (automations)
object (options)

Responses

Request samples

Content type
application/json
{
  • "automations": [
    ],
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": [
    ],
  • "metadata": { }
}

Delete Automation

Delete an Automation.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Automation to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Get Automation

Get an Automation.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Automation to get.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Update Automation

Update an Automation.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Automation to update.

Request Body schema: application/json

updates

name
string non-empty

The name of the document

description
string

The description of the document

"workflows" (any) or "ucm_compliance_plans" (any) or "resource_models" (any) or null

The type of component linked to this Automation.

object
string or string or null or "" (any)

The id of the component linked to this Automation.

Responses

Request samples

Content type
application/json
{
  • "name": "Cisco IOS upgrade",
  • "description": "Turn up the port",
  • "componentType": "workflows",
  • "gbac": {
    },
  • "componentId": "string"
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Export Automation

Export an Automation.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Automation to export.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Get Triggers

Search the Trigger collection.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
contains
string
Examples: contains=event

the value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document

containsField
string
Examples: containsField=name

the field to run a contains query on

equals
string
Examples: equals=my event trigger

the value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document

equalsField
string
Examples: equalsField=name

the field to run an equals query on

startsWith
string
Examples: startsWith=my

the value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document

startsWithField
string
Examples: startsWithField=name

the field to run a startsWith query on

greaterThanField
string
Examples: greaterThanField=lastExecuted

the field to run a greater than query on

greaterThan
string
Examples: greaterThan=04/06/2021 greaterThan=Thu Dec 03 2020 14:55:00 GMT-0500 (Eastern Standard Time) greaterThan=2020-12-03T19:55:43.189Z greaterThan=1617681600000

the value to use for the greater than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds

lessThanField
string
Examples: lessThanField=lastExecuted

the field to run a less than query on

lessThan
string
Examples: lessThan=04/06/2021 lessThan=Thu Nov 15 2018 01:30:00 GMT-0500 (Eastern Standard Time) lessThan=2020-12-03T19:55:43.189Z lessThan=1615611600000

the value to use for the less than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds

enabled
boolean

if true, then only return trigger documents that are enabled

actionId
string

if provided, only return trigger documents with this action id

limit
integer >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

Number of results to return. Used for pagination.

skip
integer >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

Number of results to skip. Used for pagination.

order
integer
Default: 1
Enum: -1 1

The sort direction: 1 for ascending or -1 for descending.

sort
string
Default: "name"
Value: "name"

Field to sort by. Default is name.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": [
    ],
  • "metadata": { }
}

Create Trigger

Create a new Trigger.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

trigger

One of
name
required
string non-empty

The name of the document

description
string

The description of the document

enabled
boolean

A flag to determine if this Trigger is enabled or not.

actionType
string
Value: "automations"

The type of component this Trigger will invoke.

actionId
string^[0-9a-f]{24}$

A string which is formatted like an ObjectId, Distinct from an actual ObjectId.

object

Configuration options specific to this trigger.

integer or null

A timestamp in milliseconds of the time this Trigger was last executed.

migrationVersion
integer

The current document version of this document.

"Pronghorn" (any) or string
created
string <date-time>

An ISO 8601 date string

"Pronghorn" (any) or string
lastUpdated
string <date-time>

An ISO 8601 date string

type
required
any
Value: "endpoint"
verb
any
Value: "POST"
routeName
required
string^[a-zA-Z0-9_-]+$

User defined route name.

object or null

POST body filter schema.

string or null

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Cisco IOS upgrade",
  • "description": "Turn up the port",
  • "enabled": true,
  • "actionType": "automations",
  • "actionId": "string",
  • "options": {
    },
  • "lastExecuted": 0,
  • "migrationVersion": 1,
  • "createdBy": "Pronghorn",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdatedBy": "Pronghorn",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "type": "endpoint",
  • "verb": "POST",
  • "routeName": "runSoftwareUpgrade",
  • "schema": { },
  • "jst": "string"
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Import Triggers

Import Triggers.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

Array of Endpoint Trigger (object) or EventSystem Trigger (object) or Manual Trigger (object) or (object or objects or objects) (triggers)
object (options)

Responses

Request samples

Content type
application/json
{
  • "triggers": [
    ],
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": [
    ],
  • "metadata": { }
}

Get Trigger

Get a Trigger.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Trigger to get.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Update Trigger

Update a Trigger.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Trigger to update.

Request Body schema: application/json

updates

One of
name
string non-empty

The name of the document

description
string

The description of the document

enabled
boolean

A flag to determine if this Trigger is enabled or not.

actionType
string
Value: "automations"

The type of component this Trigger will invoke.

actionId
string^[0-9a-f]{24}$

A string which is formatted like an ObjectId, Distinct from an actual ObjectId.

object

Configuration options specific to this trigger.

integer or null

A timestamp in milliseconds of the time this Trigger was last executed.

migrationVersion
integer

The current document version of this document.

type
any
Value: "endpoint"
verb
any
Value: "POST"
routeName
string^[a-zA-Z0-9_-]+$

User defined route name.

object or null

POST body filter schema.

string or null

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Cisco IOS upgrade",
  • "description": "Turn up the port",
  • "enabled": true,
  • "actionType": "automations",
  • "actionId": "string",
  • "options": {
    },
  • "lastExecuted": 0,
  • "migrationVersion": 1,
  • "type": "endpoint",
  • "verb": "POST",
  • "routeName": "runSoftwareUpgrade",
  • "schema": { },
  • "jst": "string"
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Delete Trigger

Delete a Trigger.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Trigger to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Delete Triggers By Action ID

Deletes all Triggers associated with the provided Automation id.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the parent Automation.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Export Trigger

Export a Trigger.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Trigger to export.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Export large data for a job or task variable

Export large data for a job or task variable

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the job_data document in GridFS

Responses

Response samples

Content type
application/json
null

OperationsManager.getEvents

Search the system events that can be used in an event Trigger.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
source
string (operations-manager_eventSystem-trigger-common_source)
Examples: source=@itential/app-operations_manager

source

topic
string (operations-manager_eventSystem-trigger-common_topic)
Examples: topic=missedJobs

topic

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": [
    ],
  • "metadata": { }
}

OperationsManager.getEventDefinition

Get an event definition.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
source
required
string (operations-manager_eventSystem-trigger-common_source)
Examples: @itential/app-operations_manager

source

topic
required
string (operations-manager_eventSystem-trigger-common_topic)
Examples: missedJobs

topic

Responses

Response samples

Content type
application/json
{
  • "source": "@itential/app-operations_manager",
  • "topic": "missedJobs",
  • "definition": { }
}

Run Endpoint Trigger With POST

Runs the Automation associated with the API Trigger.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
routeName
required
string (routeName)

The routeName of the API Trigger.

Request Body schema: application/json

body

property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Run Manual Trigger

Runs the Automation associated with the Manual Trigger.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Manual Trigger to run.

Request Body schema: application/json

request body

formData
object (formData)
object (runtimeOptions)
Default: {}

Responses

Request samples

Content type
application/json
{
  • "formData": { },
  • "runtimeOptions": { }
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Retry a task

Retry a Task that has failed execution.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
jobId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job containing the Task.

taskId
required
string (operations-manager_task-common_taskId) ^[0-9a-f]{1,4}$
Examples: e28f 3a1f b4f

The id of the Task to be retried.

Request Body schema: application/json

request body

variables
object (variables)

Responses

Request samples

Content type
application/json
{
  • "variables": { }
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Claim a task

Assign a Task to the current user.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
taskId
required
string (operations-manager_common_uuid-v4) ^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-...

The id of the Task iteration to be claimed.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Assign a task to a user

Assign a Task to a user.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
taskId
required
string (operations-manager_common_uuid-v4) ^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-...

The id of the Task iteration to be assigned.

Request Body schema: application/json

request body

userId
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

A string which is formatted like an ObjectId, Distinct from an actual ObjectId.

Responses

Request samples

Content type
application/json
{
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Release a currently assigned task

Remove user assignment from a currently assigned Task.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
taskId
required
string (operations-manager_common_uuid-v4) ^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-...

The id of the Task iteration to be released.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Gets Tasks

Search the Task collection.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
limit
integer >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

Number of results to return. Used for pagination.

skip
integer >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

Number of results to skip. Used for pagination.

order
integer
Default: 1
Enum: -1 1

Sort direction, 1 for ascending and -1 for descending.

sort
string
Default: "name"
Value: "name"

Field to sort by

include
string
Examples: include=name include=description include=name,description

Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.

exclude
string
Examples: exclude=_id exclude=description exclude=_id,description

Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.

in
string

Search for fields exactly matching one of the given list options

not-in
string

Search for fields not exactly matching one of the given list options

equals
string

Returns results where the specified fields exactly match the given match string(s).

contains
string

Returns results where the specified fields contain the given match string(s).

starts-with
string

Returns results where the specified fields start with the given match string(s).

ends-with
string

Returns results where the specified fields end in the given match string(s).

dereference
string

Designates foreign key fields to dereference in the API output.

gt
string

Returns results where the specified fields have values greater than the specified values.

gte
string

Returns results where the specified fields have values greater than or equal to the specified values.

lt
string

Returns results where the specified fields have values less than the specified values.

lte
string

Returns results where the specified fields have values less than or equal to the specified values.

q
string

Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.

actionableTasks
boolean
Default: false

If true, only returns actionable tasks that the current user has write access to.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": [
    ],
  • "metadata": {
    }
}

Get a task by ID

Get a Task.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Task to get.

query Parameters
include
string
Examples: include=name include=description include=name,description

Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.

exclude
string
Examples: exclude=_id exclude=description exclude=_id,description

Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.

dereference
string
Examples: dereference=job dereference=accounts.metrics.owner

Designates foreign key fields to dereference in the API output. The main function of this parameter is to retrieve extra information on a task that would not ordinarily be included. If information is needed on the task's parent job, the dereference parameter may be given a value of 'job'. This will look up the full job document and place it under the 'job' property in the task document. If the output of a child job task is needed, the dereference parameter may be given a value of 'child-job-output'. This will look up the output of the job initiated by the child job task. If the child job has loop settings each individual output will be provided in an array under the property 'variables.outgoing.job_details.loop'. If the child job does not have loop settings, the output of the single job document will be provided under the property 'variables.outgoing.job_details.output'.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Watch a Job

Adds the current user to the list of watchers on a Job.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
jobId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job to watch.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Unwatch Jobs

Removes the current user from the list of watchers on multiple Jobs.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

jobIds
Array of strings (jobIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "jobIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Watch Jobs

Adds the current user to the list of watchers on multiple Jobs.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

jobIds
Array of strings (jobIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "jobIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Unwatch Job

Removes the current user from the list of watchers on a Job.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
jobId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job to unwatch.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Add watchers to a Job

Adds user ids to the list of watchers on a Job.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
jobId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job to assign watchers to.

Request Body schema: application/json

request body

userIds
Array of strings (userIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Finish a manual task

Work a manual Task.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
jobId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job containing the Task to be worked.

required
any or string (operations-manager_job-common_taskId)

The id of the Task to be worked.

Request Body schema: application/json

request body

object (taskData)

Responses

Request samples

Content type
application/json
{
  • "taskData": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Get a client-side dialog controller for a manual task

Get a client-side dialog controller for a manual task

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
jobId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job containing the task

taskId
required
string (operations-manager_task-common_taskId) ^[0-9a-f]{1,4}$
Examples: e28f 3a1f b4f

The id of the Task containing the dialog controller.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Get a Job

Get a Job.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job to get.

query Parameters
include
string
Examples: include=name include=description include=name,description

Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.

exclude
string
Examples: exclude=_id exclude=description exclude=_id,description

Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.

dereference
string
Examples: dereference=tasks dereference=accounts.createdBy

Designates foreign key fields to dereference in the API output.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Gets Jobs

Search the Job collection.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": [
    ],
  • "metadata": {
    }
}

Start a Job

Spawns a Job from a Workflow.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

workflow
string (workflow)
object (options)

Responses

Request samples

Content type
application/json
{
  • "workflow": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Pauses Jobs

Pause active Jobs.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

jobIds
Array of strings (jobIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "jobIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Resumes Jobs

Resumes paused Jobs.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

jobIds
Array of strings (jobIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "jobIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Cancels Jobs

Cancel Active Jobs.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

jobIds
Array of strings (jobIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "jobIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Add GBAC to a Job

Add a group id to the groups array of a Job.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
jobId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job to modify.

Request Body schema: application/json

request body

groupId
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

A string which is formatted like an ObjectId, Distinct from an actual ObjectId.

Responses

Request samples

Content type
application/json
{
  • "groupId": "string"
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": true,
  • "metadata": { }
}

Remove all GBAC from a Job

Remove all groups from the groups array of a Job.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
jobId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job to modify.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": true,
  • "metadata": { }
}

Replace all GBAC from a Job with the provided list

Replace all groups from the groups array of a Job with the provided group array.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
jobId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job to modify.

Request Body schema: application/json

request body

groups
Array of strings (groups) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": true,
  • "metadata": { }
}

Remove GBAC from a Job

Remove a group id from the groups array of a Job.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
jobId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job to modify.

groupId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The group id to add to the Job.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": true,
  • "metadata": { }
}

Delete a root job and all related items

Only succeeds on completed or cancelled root jobs. Recursively deletes children, tasks, job data, job history, and large files.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
jobId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "metadata": { }
}

Deletes a list of provided root jobs and all their related items

Only succeeds on completed or cancelled root jobs. Ignores jobs that don't fit that criteria. Recursively deletes children, tasks, job data, job history, and large files.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

jobIds
Array of strings (jobIds) [ items^[0-9a-f]{24}$ ]

Responses

Request samples

Content type
application/json
{
  • "jobIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "metadata": { }
}

Continue a Job from a specified Task

Continue a Job from a specified Task.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
jobId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job to be continued.

Request Body schema: application/json

request body

fromTask
string (operations-manager_task-common_taskId) ^[0-9a-f]{1,4}$

Responses

Request samples

Content type
application/json
{
  • "fromTask": "e28f"
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Revert a Job

Revert a paused Job from an errored Task to a previously completed Task.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
jobId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

The id of the Job to be reverted.

Request Body schema: application/json

request body

fromTask
string (operations-manager_task-common_taskId) ^[0-9a-f]{1,4}$
any or string (operations-manager_job-common_taskId)

Responses

Request samples

Content type
application/json
{
  • "fromTask": "e28f",
  • "toTask": "workflow_start"
}

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": null,
  • "metadata": { }
}

Validate Automation

Run configuration validations against an Automation.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
required
operations-manager_common_ObjectIdLikeString (string) or operations-manager_common_name (string) (automationIdentifier)

automationIdentifier

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Validate Trigger

Run configuration validations against a Trigger.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
triggerId
required
string (operations-manager_common_ObjectIdLikeString) ^[0-9a-f]{24}$

triggerId

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully created the requested item",
  • "data": {
    },
  • "metadata": { }
}

Profiles

Creates a new profile

Create a new profile in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Get all profiles.

Get all the profiles in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
contains
string
Examples: contains=profile1

contains

containsField
string
Examples: containsField=id

containsField

equals
string
Examples: equals=profile1

equals

equalsField
string
Examples: equalsField=id

equalsField

startsWith
string
Examples: startsWith=profile

startsWith

startsWithField
string
Examples: startsWithField=id

startsWithField

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": 1
}

Import a new profile

Import a new profile in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Delete a profile.

Delete a profile from IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (Profile ID) ^[^\/]+$
Examples: profile1

Contains the id for the selected profile.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Get a single profile.

Get a single profile in the current IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (Profile ID) ^[^\/]+$
Examples: profile1

Contains the id for the selected profile.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "profile": {
    }
}

Updates a profile.

Update a profile in IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (Profile ID) ^[^\/]+$
Examples: profile1

Contains the id for the selected profile.

Request Body schema: application/json

request body

object (properties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Export a single profile.

Exports a single profile in the current IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (Profile ID) ^[^\/]+$
Examples: profile1

Contains the id for the selected profile.

Responses

Response samples

Content type
application/json
{
  • "uiProps": {
    },
  • "authenticationProps": {
    },
  • "expressProps": {
    },
  • "loggerProps": {
    },
  • "redisProps": {
    },
  • "auditProps": {
    },
  • "pathProps": {
    },
  • "alarmProps": [
    ],
  • "id": "profile1",
  • "services": [
    ],
  • "description": "An IAP Profile",
  • "adapterStrategy": {
    },
  • "systemProps": {
    },
  • "prebuiltProps": {
    },
  • "integrationProps": {
    },
  • "retryStrategy": {
    },
  • "serviceDirectory": "string"
}

Switch the active profile. Deprecated

Switch the active profile in the current IAP.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
id
required
string (Profile ID) ^[^\/]+$
Examples: profile1

Contains the id for the selected profile.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Schema

Get the adapter schema.

Get the adapter schema.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: redis email

The name for the selected adapter.

Responses

Response samples

Content type
application/json
{
  • "schema": {
    },
  • "decorators": [
    ]
}

Get the application schema.

Get the application schema.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: redis email

The name for the selected application.

Responses

Response samples

Content type
application/json
{
  • "schema": {
    },
  • "decorators": [
    ]
}

Get the integration schema.

Get the integration schema.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: ghv5 ghv6

The name for the selected integration.

Responses

Response samples

Content type
application/json
{
  • "schema": {
    },
  • "decorators": [
    ]
}

Get the profile schema.

Get the profile schema.

Authorizations:
(QueryAuthCookieAuthBasicAuth)

Responses

Response samples

Content type
application/json
{
  • "schema": {
    },
  • "decorators": [
    ]
}

Search

Search IAP

Search through IAP for results from various collections that match your search term, as well as for results that have tags that match your search term.

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (data)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Single Sign On

Create an SSO configuration

Create an SSO configuration

Authorizations:
(QueryAuthCookieAuthBasicAuth)
Request Body schema: application/json

request body

object (iap_sso-schema)

Schema describing an SSO configuration object

Responses

Request samples

Content type
application/json
{
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Get all SSO configurations

Get all SSO configurations

Authorizations:
(QueryAuthCookieAuthBasicAuth)
query Parameters
contains
string
Examples: contains=GitHub

contains

containsField
string
Enum: "name" "samlEmailAttribute" "samlUserNameAttribute" "samlGroupsAttribute" "samlFirstNameAttribute" "ssoType"

containsField

equals
string
Examples: equals=Okta

equals

equalsField
string
Enum: "name" "samlEmailAttribute" "samlUserNameAttribute" "samlGroupsAttribute" "samlFirstNameAttribute" "ssoType"

equalsField

startsWith
string
Examples: startsWith=Okta

startsWith

startsWithField
string
Enum: "name" "samlEmailAttribute" "samlUserNameAttribute" "samlGroupsAttribute" "samlFirstNameAttribute" "ssoType"

startsWithField

skip
integer (iap_common-schema_skip) >= 0
Default: 0
Examples: skip=1 skip=10 skip=50

skip

limit
integer (iap_common-schema_limit) >= 0
Default: 25
Examples: limit=1 limit=10 limit=50

limit

sort
string (iap_common-schema_sort)
Default: "name"
Value: "name"

sort

order
integer (iap_common-schema_order)
Default: 1
Enum: -1 1

order

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": 1
}

Delete an SSO configuration

Delete an SSO configuration

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: Auth0 Okta

The name of the SSO configuration to delete

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message"
}

Get a single SSO configuration

Get a single SSO configuration

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (name)
Examples: Auth0 Okta

The name of the SSO configuration to get

Responses

Response samples

Content type
application/json
{
  • "name": "Auth0",
  • "ssoType": "saml",
  • "settings": {
    },
  • "active": false,
  • "tested": true
}

Update an SSO configuration

Update an SSO configuration

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (result)
Examples: Auth0 Okta

The name of the SSO configuration to delete

Request Body schema: application/json

request body

object (iap_sso-schema)

Schema describing an SSO configuration object

Responses

Request samples

Content type
application/json
{
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "A sample success message",
  • "data": {
    }
}

Activate an SSO configuration

Activate an SSO configuration

Authorizations:
(QueryAuthCookieAuthBasicAuth)
path Parameters
name
required
string (result)
Examples: Auth0 Okta

The name of the SSO configuration to delete

Request Body schema: application/json

request body

active
boolean (active)

Responses