API docs by Redocly

Provider Connectivity Assurance API documentation (25.7)

Download OpenAPI specification:

Introduction

This API is documented in Open API format v2. You can download the full API spec above, and use it with compatible code generators to generate the client stubs.

Quick setup

(Almost) every endpoint require a valid user authentication, so this is probably where you should start. Depending on the access rights associated with your account, some endpoints may not be authorized. When such restriction exists, the API documentation will outline which acess rights are required to access or modify a given resource.

Authenticate to obtain an Authorized Token

You must optain an Authorization Bearer (for subsequent API calls) or a set-cookie, for browser related calls. Both of these can be obtained by the auth/login endpoint.

curl -X POST \
   https://{url}/api/v1/auth/login \
   -H 'Cache-Control: no-cache' \
   -H 'Content-Type: application/x-www-form-urlencoded' \
   -d 'username=tenantUsername&password=tenantUserPassword' -v

Pro-tip: Replace "{url}" by your path The response will contained an authorized header and a set-cookie header

HTTP/2 200
content-type: application/vnd.api+json
content-length: 208
authorization: Bearer MTUzNTAyNDg[...]
set-cookie: skylight-aaa=MTUzNTAyNDg[...]
{
  "data": {
    "attributes":{
      "emailAddress":"tenantUsername",
      "isPasswordSet":true,
      "isRegisteredForEmail":false,
      "name":"tenantName",
      "roles":["tenant-role"],
      "tenants":["tenantName"]},
      "id":"1",
      "type":"users"
      }
}

CertificateService

/distribution/sign-csr

query Parameters
certduration
string
Request Body schema: application/octet-stream
required
string

Responses

/distribution/renew-certs

query Parameters
certduration
string
Request Body schema: application/octet-stream
required
string

Responses

Returns data of all client certs.

query Parameters
page
integer >= 1

The page index of the returned results.

pageSize
integer >= 1

The maximum number of results to return on a page.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "bodyFilters": { },
  • "data": [
    ]
}

Get cert data of certificate specified by serial number.

path Parameters
serialNum
required
integer <int64>

Unique Serial Number identifier of the Certificate to be returned

Responses

Response samples

Content type
application/vnd.api+json
{
  • "serialNum": "string",
  • "tenantId": "string",
  • "userId": "string",
  • "status": "Good",
  • "reason": "Unspecified",
  • "expiry": 0
}

Certificate OCSP check request

path Parameters
ocspRequest
required
string

OCSP DER encoded request

Responses

Revoke an existing Client Cert in Skylight AAA. Does not update Expiry.

path Parameters
serialNum
required
integer <int64>

Unique Serial Number identifier of the Certificate to be returned

Request Body schema: application/vnd.api+json
required
reason
required
string
Enum: "Unspecified" "KeyCompromise" "CACompromise" "AffiliationChanged" "Superseded" "CessationOfOperation" "CertificateHold" "RemoveFromCRL" "PrivilegeWithdrawn" "AACompromise"

Responses

Request samples

Content type
application/vnd.api+json
{
  • "reason": "Unspecified"
}

Response samples

Content type
application/vnd.api+json
{
  • "serialNum": "string",
  • "tenantId": "string",
  • "userId": "string",
  • "status": "Good",
  • "reason": "Unspecified",
  • "expiry": 0
}

AuthService

/oidc-redirect

query Parameters
clientName
required
string

The name of the OP we'll be delegating auth to

Responses

Response samples

Content type
"string"

callback

query Parameters
state
string
code
string

Responses

Response samples

Content type
{
  • "data": {
    }
}

OpenIDConfiguration

path Parameters
clientName
required
string

The name of the openID provider we're trying to access

Responses

Response samples

Content type
{
  • "issuer": "string",
  • "authorization_endpoint": "string",
  • "token_endpoint": "string",
  • "token_introspection_endpoint": "string",
  • "userinfo_endpoint": "string",
  • "end_session_endpoint": "string",
  • "jwks_uri": "string",
  • "check_session_iframe": "string",
  • "grant_types_supported": [
    ],
  • "response_types_supported": [
    ],
  • "subject_types_supported": [
    ],
  • "id_token_signing_alg_values_supported": [
    ],
  • "userinfo_signing_alg_values_supported": [
    ],
  • "request_object_signing_alg_values_supported": [
    ],
  • "response_modes_supported": [
    ],
  • "registration_endpoint": "string",
  • "token_endpoint_auth_methods_supported": [
    ],
  • "token_endpoint_auth_signing_alg_values_supported": [
    ],
  • "claims_supported": [
    ],
  • "claim_types_supported": [
    ],
  • "claims_parameter_supported": true,
  • "scopes_supported": [
    ],
  • "request_parameter_supported": true,
  • "request_uri_parameter_supported": true
}

OpenIDToken

path Parameters
clientName
required
string

The name of the openID provider we're trying to access

Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string
Default: "authorization_code"
Value: "authorization_code"
code
required
string
client_id
string
client_secret
string

Responses

Response samples

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

OpenIDAuth

query Parameters
client_id
required
string

Our client ID which is registered in the OP

redirect_uri
required
string

URI of where the OP will redirect upon successful authentication

response_type
required
string
Default: "code"

What we are requesting from the OP

state
required
string

Value that has to match between OIDC requests

delegatedclientid
string
scope
required
string
Default: "openid"

scope of the OIDC request

Responses

SamlRedirect

query Parameters
clientName
required
string

The name of the SAML client we'll be delegating auth to

Responses

Response samples

Content type
"string"

SamlCallback

Request Body schema: application/x-www-form-urlencoded
required
SAMLResponse
required
string
RelayState
required
string

Responses

Response samples

Content type
application/json
"string"

SamlSpMetadata

path Parameters
clientName
required
string

The name of the SAML provider we're trying to access

Responses

Create a new User in Skylight AAA

Request Body schema: application/vnd.api+json
required
object (AAAUser)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a list of Users known to Skylight AAA

query Parameters
page
integer >= 1

The page index of the returned results.

pageSize
integer >= 1

The maximum number of results to return on a page.

inclusive
boolean

Overrides the boolean operator to use 'OR' instead 'AND' by default when combining filters.

emailAddress
Array of strings

Email addresses to filter Users by.

name
Array of strings

The name of the user to filter Users by.

includePermissions
boolean
Default: true

Include groups, roles, and respective permissions

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "bodyFilters": { },
  • "data": [
    ]
}

Search for Users based on various criteria

query Parameters
page
integer >= 1

The page index of the returned results.

pageSize
integer >= 1

The maximum number of results to return on a page.

inclusive
boolean

Overrides the boolean operator to use 'OR' instead 'AND' by default when combining filters.

Request Body schema: application/vnd.api+json
required
usergroupIds
Array of integers <int64> [ items <int64 > ]

List of Usergroup IDs to filter users by.

usergroupNames
Array of strings

List of Usergroup Names to filter users by.

names
Array of strings

List of names to filter users by.

emailAddresses
Array of strings

List of email addresses to filter users by.

includePermissions
boolean
Default: true

Whether to include groups, roles, and respective permissions with users

Responses

Request samples

Content type
application/vnd.api+json
{
  • "usergroupIds": [
    ],
  • "usergroupNames": [
    ],
  • "names": [
    ],
  • "emailAddresses": [
    ],
  • "includePermissions": true
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "bodyFilters": { },
  • "data": [
    ]
}

Count Users based on various criteria

query Parameters
inclusive
boolean

Overrides the boolean operator to use 'OR' instead 'AND' by default when combining filters.

Request Body schema: application/vnd.api+json
names
Array of strings

List of names to filter users by.

emailAddresses
Array of strings

List of email addresses to filter users by.

usergroupIds
Array of integers <int64> [ items <int64 > ]

List of Usergroup IDs to filter users by.

usergroupNames
Array of strings

List of Usergroup Names to filter users by.

groupBy
Array of strings
Items Enum: "id" "name" "emailAddress" "usergroupId" "usergroupName"

List of columns to group by. Allowed values are 'usergroupId', 'roleId', 'departmentId'.

Responses

Request samples

Content type
application/vnd.api+json
{
  • "names": [
    ],
  • "emailAddresses": [
    ],
  • "usergroupIds": [
    ],
  • "usergroupNames": [
    ],
  • "groupBy": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "total": { },
  • "groupedBy": [
    ],
  • "data": { }
}

Update an existing User in Skylight AAA. Does not update User email or Password.

path Parameters
userId
required
integer <int64>

The unique identifier of the User to be updated.

Request Body schema: application/vnd.api+json
required
object (AAAUser)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update properties of an existing User in Skylight AAA. Does not update User email or Password.

path Parameters
userId
required
integer <int64>

The unique identifier of the User to be updated.

Request Body schema: application/vnd.api+json
required
object (AAAUser)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a single User by its known Id.

path Parameters
userId
required
integer <int64>

The unique identifier of the User to be returned.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a single User by its known Id.

path Parameters
userId
required
integer <int64>

The unique identifier of the User to be deleted.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Reset a pasword for a User provisioned in Skylight AAA.

path Parameters
userId
required
integer <int64>

The unique identifier of the User to reset the password.

Responses

Change the email address of a User provisioned in Skylight AAA.

path Parameters
userId
required
integer <int64>

The unique identifier of the User which is changing email address

Request Body schema: application/json
required
oldEmailAddress
required
string <email> <= 256 characters
newEmailAddress
required
string <email> <= 256 characters
password
string <= 256 characters

Responses

Request samples

Content type
application/json
{
  • "oldEmailAddress": "user@example.com",
  • "newEmailAddress": "user@example.com",
  • "password": "string"
}

Update properties of the currently authenticated User in Skylight AAA. Does not update User email or Password.

Request Body schema: application/vnd.api+json
required
object (AAAUser)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve the currently Authenticated User.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete the currently Authenticated User.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Updates the password of the currently Authenticated User.

Request Body schema: application/json
required
oldPassword
required
string [ 8 .. 64 ] characters
newPassword
required
string [ 9 .. 64 ] characters

Password must be at least 9 characters long, contain at least one number, contain at least one special character, and must have a mixture of uppercase and lowercase letters

Responses

Request samples

Content type
application/json
{
  • "oldPassword": "stringst",
  • "newPassword": "stringstr"
}

Change the email address of the currently Authenticated User.

Request Body schema: application/json
required
oldEmailAddress
required
string <email> <= 256 characters
newEmailAddress
required
string <email> <= 256 characters
password
string <= 256 characters

Responses

Request samples

Content type
application/json
{
  • "oldEmailAddress": "user@example.com",
  • "newEmailAddress": "user@example.com",
  • "password": "string"
}

Retrieve the User mapped to the onboarding token.

path Parameters
onboardingToken
required
string

The one-time use token provided to access the password set operation

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Sets the password of a User that has had their password reset.

Request Body schema: application/json
required
password
required
string [ 9 .. 64 ] characters

Password must be at least 9 characters long, contain at least one number, contain at least one special character, and must have a mixture of uppercase and lowercase letters

onboardingToken
required
string <= 256 characters

Responses

Request samples

Content type
application/json
{
  • "password": "stringstr",
  • "onboardingToken": "string"
}

Login a Skylight User

Request Body schema: application/x-www-form-urlencoded
username
string

Unique identifier of the User requesting access

password
string

Password for the username of the User requesting access

token
string

Signed JWT issues by Accedian. Can be used instead of username/password

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Logout a Skylight User

Responses

Response samples

Content type
application/vnd.api+json
"string"

Validate an active Skylight Session and return User data

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Validate an active Skylight Session. Sets headers for proxy requests to have access to user data.

Responses

Create a new Service in Skylight AAA. This function is only available to Skylight Admin users.

Request Body schema: application/x-www-form-urlencoded
required
serviceName
required
string

Unique identifier of the Service to be added

username
required
string

Username

password
required
string

Password

Responses

Retrieves the generic identifyiong information for a customer.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Adds tenant identifying information which is retreived in the 'onboarding/tenant-info' call. Operation is only available to Skylight Administrators.

Request Body schema: application/vnd.api+json
required
object (TenantInfo)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Deletes tenant identifying information. Operation is only available to Skylight Administrators.

path Parameters
subdomain
required
string

Unique identifier of the Subdomain to delete the tenant mapping

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a new web token for authentication/authorization

Request Body schema: application/vnd.api+json
required
object (JWTClaims)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a list of Tokens known to Skylight AAA

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a single Token by its known Id.

path Parameters
tokenId
required
integer <int64>

The unique identifier of the Token to be returned.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update an existing Token in Skylight AAA.

path Parameters
tokenId
required
integer <int64>

The unique identifier of the Token to be updated.

Request Body schema: application/vnd.api+json
required
object (JWTClaims)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a single Token by its known Id.

path Parameters
tokenId
required
integer <int64>

The unique identifier of the Token to be deleted.

Responses

Response samples

Content type
application/vnd.api+json
"string"

Validate a JWT. Sets headers for proxy requests to have access to have Tenant Id.

Responses

Validate a zitadel PAT or access_token. Sets headers for proxy requests to have access to have Tenant Id.

Responses

Validate a cert authorization, does not perform authentication. Sets headers for proxy requests to have access to have Tenant Id.

Responses

Returns a method for authentication given an email address

path Parameters
emailAddress
required
string

Email address of the user trying to authenticate

Responses

Response samples

Content type
application/vnd.api+json
{
  • "method": "password",
  • "providerLinks": [
    ]
}

Create a new Usergroup in Skylight AAA

Request Body schema: application/vnd.api+json
required
object (Usergroup)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a list of Usergroups known to Skylight AAA

query Parameters
page
integer >= 1

The page index of the returned results.

pageSize
integer >= 1

The maximum number of results to return on a page.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "bodyFilters": { },
  • "data": [
    ]
}

Search for Usergroups based on various criteria

query Parameters
page
integer >= 1

The page index of the returned results.

pageSize
integer >= 1

The maximum number of results to return on a page.

inclusive
boolean

Overrides the boolean operator to use 'OR' instead 'AND' by default when combining filters.

Request Body schema: application/vnd.api+json
required
ids
Array of integers <int64> [ items <int64 > ]

List of Usergroup IDs to filter users by.

names
Array of strings

List of Usergroup names to filter by.

includeRelationships
boolean
Default: false

Include roles, and users in Usergroup response

Responses

Request samples

Content type
application/vnd.api+json
{
  • "ids": [
    ],
  • "names": [
    ],
  • "includeRelationships": false
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "bodyFilters": { },
  • "data": [
    ]
}

Count Usergroups based on various criteria

Request Body schema: application/vnd.api+json
names
Array of strings

List of Usergroup names to filter by.

Responses

Request samples

Content type
application/vnd.api+json
{
  • "names": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "total": { },
  • "groupedBy": [
    ],
  • "data": { }
}

Retrieve a single Usergroup by its known Id.

path Parameters
usergroupId
required
integer <int64>

The unique identifier of the Usergroup to be returned.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update an existing Usergroup in Skylight AAA.

path Parameters
usergroupId
required
integer <int64>

The unique identifier of the Usergroup to be updated.

Request Body schema: application/vnd.api+json
required
object (UsergroupUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a single Usergroup by its known Id.

path Parameters
usergroupId
required
integer <int64>

The unique identifier of the Usergroup to be deleted.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a new Role in Skylight AAA

Request Body schema: application/vnd.api+json
required
object (Role)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a list of Roles known to Skylight AAA in the context of the active tenant

query Parameters
page
integer >= 1

The page index of the returned results.

pageSize
integer >= 1

The maximum number of results to return on a page.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "bodyFilters": { },
  • "data": [
    ]
}

Retrieve a single Role by its known Id

path Parameters
roleId
required
integer <int64>

The unique identifier of the Role to be returned

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update an existing Role in Skylight AAA

path Parameters
roleId
required
integer <int64>

The unique identifier of the Role to be updated.

Request Body schema: application/vnd.api+json
required
object (RoleUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a single Role by its known Id

path Parameters
roleId
required
integer <int64>

The unique identifier of the Role to be deleted.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a new Permission in Skylight AAA

Request Body schema: application/vnd.api+json
required
object (Permission)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a list of Permissions known to Skylight AAA in the context of the active tenant

query Parameters
page
integer >= 1

The page index of the returned results.

pageSize
integer >= 1

The maximum number of results to return on a page.

domains
Array of strings

Filter permissions by comma separated list of domains

app
Array of strings

Filter permissions by app

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "bodyFilters": { },
  • "data": [
    ]
}

Retrieve a single Permission by its known Id

path Parameters
permissionId
required
integer <int64>

The unique identifier of the Permission to be returned

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update an existing Permission in Skylight AAA

path Parameters
permissionId
required
integer <int64>

The unique identifier of the Permission to be updated.

Request Body schema: application/vnd.api+json
required
object (PermissionUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a single Permission by its known Id

path Parameters
permissionId
required
integer <int64>

The unique identifier of the Permission to be deleted.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a service account and return the associated personal access token (PAT)

query Parameters
withPAT
boolean

If set to true, a valid Personal Access Token for the service account is created and returned as well. Requires expirationDate

header Parameters
X-Forwarded-Tenant-Id
required
string
Request Body schema: application/json
required
username
required
string
name
required
string
description
string
accessTokenType
required
string
Default: "Bearer"
Enum: "Bearer" "Jwt"
expirationDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "name": "string",
  • "description": "string",
  • "accessTokenType": "Bearer",
  • "expirationDate": "2021-01-01T01:00:00+00:00"
}

Response samples

Content type
{
  • "machineUserId": "string",
  • "pat": "string"
}

TicketService

Create a Granting Ticket used to obtain Service Tickets

Request Body schema: application/x-www-form-urlencoded
required
username
required
string

Unique identifier of the User requesting access

password
required
string

Password for the username of the User requesting access

service
required
string
Default: "https://cas.local/aastubs/"
Value: "https://cas.local/aastubs/"

URL of the granting service.

Responses

Obtain a Service Ticket used to access a particular resource

Request Body schema: application/x-www-form-urlencoded
required
grantingTicket
required
string

The URL Granting ticket used to obtain the Service Ticket

service
required
string
Default: "https://cas.local/aastubs/"
Value: "https://cas.local/aastubs/"

URL of the granting service.

Responses

Validate a Service Ticket used to access a particular resource

query Parameters
ticket
required
string

The Service Ticket to be validated.

service
required
string
Default: "https://cas.local/aastubs/"
Value: "https://cas.local/aastubs/"

URL of the granting service.

format
required
string
Default: "JSON"
Value: "JSON"

The format of the validation response body.

Responses

Response samples

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

ExportService

Creates an export configuration

Request Body schema: application/vnd.api+json
required
object (ExportConfigurationMeta)

Resuable block for users to see permission properties for a resource

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Gets a list of export report

query Parameters
include_doc
boolean
Default: false

If true, then the reports themselves will be returned, otherwise, only the document IDs

raw_metadata_key
boolean
Default: false

Metadata are mapped internally for speed and this flag exposes the actual key

enabled
boolean
Default: true

Only return enabled configs

Responses

Response samples

Content type
application/vnd.api+json
[
  • {
    }
]

Gets an export configuration

path Parameters
conf_id
required
string
query Parameters
raw_metadata_key
boolean
Default: false

Metadata are mapped internally for speed and this flag exposes the actual key

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Patch an export Configuration

path Parameters
conf_id
required
string
Request Body schema: application/vnd.api+json
required
object (ExportConfigurationMeta)

Resuable block for users to see permission properties for a resource

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Disables an export Configuration

path Parameters
conf_id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Delete an export Configuration

path Parameters
conf_id
required
string

Responses

Response samples

Content type
application/vnd.api+json
"string"

Gets a list of export report

path Parameters
conf_id
required
string

Responses

Response samples

Content type
application/vnd.api+json
[
  • {
    }
]

Download a report csv

path Parameters
conf_id
required
string
fileName
required
string

Responses

Delete a report csv

path Parameters
conf_id
required
string
fileName
required
string

Responses

Response samples

Content type
application/vnd.api+json
"string"

AdminGetSolutionManifest

Retrieves the Skylight Analytics release and solution versions as well as the manifest of all services. If the local manifest has been manually modified, the isDirty flag is set to indicate that the currently running version differs from the original version

Responses

Response samples

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

Time Window Exclusions

Provisions a time exclusion for the current tenant

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieves all provisioned time exclusion for the current tenant

query Parameters
start
integer

Filter TWEs with events (occurrences) after the start timestamp (inclusive) in ms

end
integer

Filter TWEs with events (occurrences) earlier than the end timestamp (inclusive) in ms

type
string

Filter by TWE type i.e.: busyHour | maintenance

archived
boolean

If true, archived TWEs are returned, otherwise active TWEs are returned

pageSize
integer

Number of TWEs returned on a single page

page
integer

The page number

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    }
}

Updates a provisioned time exclusion of the current tenant

path Parameters
id
required
string
Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Replaces a provisioned time exclusion of the current tenant with the time exclusion provided in the body

path Parameters
id
required
string
Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieves a provisioned time exclusion for the current tenant by name

path Parameters
id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Removes a provisioned time exclusion for the current tenant by name

path Parameters
id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

Returns all time window exclusions for the tenant that have occurrences between start and end time. If monitoredObjectID is specified, only time window exclusions that affect the monitored object during the specified time window are returned

query Parameters
start
required
integer
end
required
integer
monitoredObjectID
string
pageSize
integer

Number of TWEs and events returned on a single page

page
integer

The page number

type
string

Filter by TWE type i.e.: busyHour | maintenance

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    }
}

AdminProvisioningServiceV2

Create a Tenant.

Request Body schema: application/vnd.api+json
required
required
object (TenantCreationObject)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all Tenants.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant by id.

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Patch a Tenant

path Parameters
tenantId
required
string
Request Body schema: application/vnd.api+json
required
required
object (TenantUpdateObject)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Returns the Id of a Tenant that matches the provided alias.

path Parameters
value
required
string

Responses

Returns a summary of the Tenant that matches the provided alias.

path Parameters
value
required
string

Responses

Response samples

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

Retrieve an Ingestion Dictionary.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Valid Types object.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant's Metadata. This API is authorized to Datahub Administrators only.

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Tenant's Metadata. This API is authorized to Datahub Administrators only.

path Parameters
tenantId
required
string
Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

TenantAlertServiceV2

Retrieve the alerts for a given monitoredObjectId over an interval

path Parameters
monitoredObjectId
required
string

The monitored object id

query Parameters
interval
required
string

The interval in ISO 8601 standard but with the '/' replaced with '_'

alertState
string
Enum: "raised" "cleared" "activeAndCleared"

Filter on a particular condition. If left empty, both raised and clears will be returned.

policyId
string

The Policy ID

Responses

Response samples

Content type
{
  • "data": [
    ]
}

Retrieve active alerts for the provided monitoredObjectId

path Parameters
monitoredObjectId
required
string

The monitored object id

query Parameters
policyId
string

The policyId

Responses

Response samples

Content type
{
  • "data": [
    ],
  • "meta": {
    }
}

Delete Active Alerts for the provided monitoredObjectId

path Parameters
monitoredObjectId
required
string

The monitored object id

query Parameters
policyId
string

The policyId

Responses

Response samples

Content type
"string"

Create active alerts for the provided monitoredObjectId

Request Body schema:
required

The Active Alert

tenantId
required
string

The tenant ID

objectId
required
string

The Object ID for the active alert

policyId
required
string

The policy ID

policyName
string <string>

Message is associated with an existing policy's Name

direction
string

The direction of the metric that caused the alert

raiseProcessedAt
integer <int64>

When the alert was raised at. Note this is not the record's timestamp

startTimestamp
integer <int64>

The timestamp of the last record in the series to trigger this alert

endTimestamp
integer <int64>

The timestamp of the last record in the series to trigger the clearing of this alert

alertState
string
Enum: "raised" "cleared" "error" "forced-clear"

Message type forced-clear - raised - Policy is declaring violation conditions are met cleared - Policy is declaring recovery conditions are met error - Analytics engine encountered an error at timestamp

policyType
string
Enum: "micro-tca" "anomaly" "capture" "capture-automatic" "security" "capture-v2" "percentage-violations" "baseline-percent"
metric
string
duration
number

The total amount of time spent in violation

object^[a-z_]+$

Attributes added to a Monitored Object that help identify the Monitored Object as well as provide flitering/grouping properties

srcLat
number <float>

Geographic latitude of Monitored Object source

srcLon
number <float>

Geographic longitude of Monitored Object source

dstLat
number <float>

Geographic latitude of Monitored Object destination

dstLon
number <float>

Geographic longitude of Monitored Object destination

object (MonitoredObjectLocation)

Defines the geographical location of the Monitored Object

object (MonitoredObjectLocation)

Defines the geographical location of the Monitored Object

topology
Array of strings

Tags used to describe the path segments associated with the Monitored Object

value
string

This can either be the threshold value or a distance measure for dynamic thresholds

triggeredValue
string

This is actual metric value which triggers the alert

baseline
string

This is the baseline value of the object metric at the time when alert is raised or cleared

comparator
string
Default: "gt"
Enum: "gt" "lt" "eq" "gte" "lte"

Operand to use when evaluating the condition. gt = greaterThan lt = lessThan eq = equal

sessionId
string
bcn
string
bca
string
uuid
string
ip
string
captureLayer
string
captureZone
string
captureApplicationId
string
captureZoneId
string
captureMetaThresholds
number
captureMetaValues
string
captureMetaIps
string
captureMetaDesc
string
captureMetaDate_stop
number
captureMetaDate_start
number
captureMetaIp_client
string
captureMetaIp_count
number
captureMetaStart
number
captureMetaStop
number
captureMetaName
string
captureMetaAlert_id
number
captureMetaNow
number
captureMetaFirst_sent
number
captureMetaLast_sent
number
captureMetaSite
string
captureMetaWorker
string
captureMetaFiring
string
captureMetaCertainty
number
captureMetaHostname
string
captureMetaCertainty_percent
number
captureClientZoneId
string
captureServerZoneId
string
severity
string
sourceIp
string
destinationIp
string
mitreTactics
Array of strings
alertClusterId
string
securityJobType
string
sourceNetworkAssetRoles
string
destinationNetworkAssetRoles
string
object (ActiveAlertSecurityState)
sourcePort
integer
destinationPort
integer
assignedIncidentId
string
securityPolicyId
string

Responses

Request samples

Content type
{
  • "tenantId": "string",
  • "objectId": "string",
  • "policyId": "string",
  • "policyName": "string",
  • "direction": "string",
  • "raiseProcessedAt": 0,
  • "startTimestamp": 0,
  • "endTimestamp": 0,
  • "alertState": "raised",
  • "policyType": "micro-tca",
  • "metric": "string",
  • "duration": 0,
  • "meta": {
    },
  • "srcLat": 0.1,
  • "srcLon": 0.1,
  • "dstLat": 0.1,
  • "dstLon": 0.1,
  • "sourceLocation": {
    },
  • "destinationLocation": {
    },
  • "topology": [
    ],
  • "value": "string",
  • "triggeredValue": "string",
  • "baseline": "string",
  • "comparator": "gt",
  • "sessionId": "string",
  • "bcn": "string",
  • "bca": "string",
  • "uuid": "string",
  • "ip": "string",
  • "captureLayer": "string",
  • "captureZone": "string",
  • "captureApplicationId": "string",
  • "captureZoneId": "string",
  • "captureMetaThresholds": 0,
  • "captureMetaValues": "string",
  • "captureMetaIps": "string",
  • "captureMetaDesc": "string",
  • "captureMetaDate_stop": 0,
  • "captureMetaDate_start": 0,
  • "captureMetaIp_client": "string",
  • "captureMetaIp_count": 0,
  • "captureMetaStart": 0,
  • "captureMetaStop": 0,
  • "captureMetaName": "string",
  • "captureMetaAlert_id": 0,
  • "captureMetaNow": 0,
  • "captureMetaFirst_sent": 0,
  • "captureMetaLast_sent": 0,
  • "captureMetaSite": "string",
  • "captureMetaWorker": "string",
  • "captureMetaFiring": "string",
  • "captureMetaCertainty": 0,
  • "captureMetaHostname": "string",
  • "captureMetaCertainty_percent": 0,
  • "captureClientZoneId": "string",
  • "captureServerZoneId": "string",
  • "severity": "string",
  • "sourceIp": "string",
  • "destinationIp": "string",
  • "mitreTactics": [
    ],
  • "alertClusterId": "string",
  • "securityJobType": "string",
  • "sourceNetworkAssetRoles": "string",
  • "destinationNetworkAssetRoles": "string",
  • "securityState": {
    },
  • "sourcePort": 0,
  • "destinationPort": 0,
  • "assignedIncidentId": "string",
  • "securityPolicyId": "string"
}

Response samples

Content type
{
  • "tenantId": "string",
  • "objectId": "string",
  • "policyId": "string",
  • "policyName": "string",
  • "direction": "string",
  • "raiseProcessedAt": 0,
  • "startTimestamp": 0,
  • "endTimestamp": 0,
  • "alertState": "raised",
  • "policyType": "micro-tca",
  • "metric": "string",
  • "duration": 0,
  • "meta": {
    },
  • "srcLat": 0.1,
  • "srcLon": 0.1,
  • "dstLat": 0.1,
  • "dstLon": 0.1,
  • "sourceLocation": {
    },
  • "destinationLocation": {
    },
  • "topology": [
    ],
  • "value": "string",
  • "triggeredValue": "string",
  • "baseline": "string",
  • "comparator": "gt",
  • "sessionId": "string",
  • "bcn": "string",
  • "bca": "string",
  • "uuid": "string",
  • "ip": "string",
  • "captureLayer": "string",
  • "captureZone": "string",
  • "captureApplicationId": "string",
  • "captureZoneId": "string",
  • "captureMetaThresholds": 0,
  • "captureMetaValues": "string",
  • "captureMetaIps": "string",
  • "captureMetaDesc": "string",
  • "captureMetaDate_stop": 0,
  • "captureMetaDate_start": 0,
  • "captureMetaIp_client": "string",
  • "captureMetaIp_count": 0,
  • "captureMetaStart": 0,
  • "captureMetaStop": 0,
  • "captureMetaName": "string",
  • "captureMetaAlert_id": 0,
  • "captureMetaNow": 0,
  • "captureMetaFirst_sent": 0,
  • "captureMetaLast_sent": 0,
  • "captureMetaSite": "string",
  • "captureMetaWorker": "string",
  • "captureMetaFiring": "string",
  • "captureMetaCertainty": 0,
  • "captureMetaHostname": "string",
  • "captureMetaCertainty_percent": 0,
  • "captureClientZoneId": "string",
  • "captureServerZoneId": "string",
  • "severity": "string",
  • "sourceIp": "string",
  • "destinationIp": "string",
  • "mitreTactics": [
    ],
  • "alertClusterId": "string",
  • "securityJobType": "string",
  • "sourceNetworkAssetRoles": "string",
  • "destinationNetworkAssetRoles": "string",
  • "securityState": {
    },
  • "sourcePort": 0,
  • "destinationPort": 0,
  • "assignedIncidentId": "string",
  • "securityPolicyId": "string"
}

Retrieve active alerts for the provided policyId

path Parameters
policyId
required
string

The policyId

Responses

Response samples

Content type
{
  • "data": [
    ],
  • "meta": {
    }
}

Delete Active Alerts for the provided policyId

path Parameters
policyId
required
string

The policyId

query Parameters
monitoredObjectId
string

The monitored object id

Responses

Response samples

Content type
"string"

Retrieves specified aggregation grouped by the provided fields and filtered by the metadata specification

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Aggregates the provided metrics and filters them based on the provided criteria

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve Active Alerts based on the provided filter criterea

Request Body schema:
required
object (ActiveAlertsQueryContext)
object (expressions)
object (MetaFilter)

An object that allows filtering on arbitrary metadata criteria and their values. The keys in the map are associated with metadata categories and the value array corresponds to a set of whitelist filter-in values for that category. The logical semantics associated with this structure are conditional-AND across metadata criteria (keys) and conditional-OR across the values contained within the value array. For example, {"region":["montreal","ottawa"], "group":["radio"]} will match all records that are of group "radio" AND from the region "montreal" OR "ottawa"

metaExclude
Array of strings (MetaExclude)

An array that allows blacklisting one or more metadata criteria. Each key in the array must correspond to a given key in the MetaFilter portion of the request. This exclusion is a logical NOT for any values belonging to the metadata criteria listed in this request. For example, if the MetaFilter is: {"region":["montreal","ottawa"], "group":["radio"]}, we can have a MetaExclude of the form ["region"]. This would result in a request that includes any records that are of group "radio" AND NOT in regions Ottawa or Montreal.

uuid
Array of strings
objectId
Array of strings

The Object ID for the active alert

policyName
string <string>

Message is associated with an existing policy's Name

policyId
Array of strings

The policy ID

policyType
Array of strings
direction
Array of strings

The direction of the metric that caused the alert

metric
Array of strings
topology
Array of strings
captureZone
Array of strings
captureApplicationId
Array of strings
captureZoneId
Array of strings
captureLayer
Array of strings
captureClientZoneId
Array of strings
captureServerZoneId
Array of strings
severity
Array of strings
object (GeoFence)
object (GeoFence)
sourceIp
Array of strings
destinationIp
Array of strings
mitreTactics
Array of strings
alertClusterId
Array of strings

The Cluster ID for the active alert

securityJobType
Array of strings
sourceNetworkAssetRoles
Array of strings
destinationNetworkAssetRoles
Array of strings
search
Array of strings

Responses

Request samples

Content type
{
  • "queryContext": {
    },
  • "expressions": {
    },
  • "meta": {
    },
  • "metaExclude": [
    ],
  • "uuid": [
    ],
  • "objectId": [
    ],
  • "policyName": "string",
  • "policyId": [
    ],
  • "policyType": [
    ],
  • "direction": [
    ],
  • "metric": [
    ],
  • "topology": [
    ],
  • "captureZone": [
    ],
  • "captureApplicationId": [
    ],
  • "captureZoneId": [
    ],
  • "captureLayer": [
    ],
  • "captureClientZoneId": [
    ],
  • "captureServerZoneId": [
    ],
  • "severity": [
    ],
  • "sourceLocation": {
    },
  • "destinationLocation": {
    },
  • "sourceIp": [
    ],
  • "destinationIp": [
    ],
  • "mitreTactics": [
    ],
  • "alertClusterId": [
    ],
  • "securityJobType": [
    ],
  • "sourceNetworkAssetRoles": [
    ],
  • "destinationNetworkAssetRoles": [
    ],
  • "search": [
    ]
}

Response samples

Content type
{
  • "data": [
    ],
  • "meta": {
    }
}

Retrieve Counts of Active Alerts based on the provided filter criterea

Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
{
  • "data": {
    }
}

Update the security state of alerts with provided objectIDs

Request Body schema:
required
targetAlerts
required
Array of strings

A list of objectIDs of alerts to change security state of

newState
required
string
Enum: "new" "in-progress" "resolved" "closed"
comment
string

Responses

Request samples

Content type
{
  • "targetAlerts": [
    ],
  • "newState": "new",
  • "comment": "string"
}

Response samples

Content type
"string"

createPolicyRecoversOnAllowList

creates an allow-list and attaches it to alert-policy's specified condition to recoversOn attribute.

path Parameters
id
required
string

alert policy ID

conditionNum
required
integer

existing number of conditions element

Request Body schema:
required
description
string
required
Array of objects (MultipleValuesEntry)
object

Responses

Request samples

Content type
{
  • "description": "string",
  • "triggerConditions": [
    ],
  • "workingHours": {
    }
}

Response samples

Content type
{
  • "id": "",
  • "rev_id": "",
  • "relatedPolicies": [
    ],
  • "triggerConditions": [
    ],
  • "workingHours": {
    },
  • "description": "string",
  • "isAutomated": false,
  • "acceptingStatus": "NOT_YET_ACTIONED",
  • "modifiedBy": "string",
  • "createdBy": "string",
  • "createdTimestamp": 0,
  • "lastModifiedTimestamp": 0
}

createPolicyTriggersOnAllowList

creates an allow-list and attaches it to alert-policy's specified condition to triggersOn attribute.

path Parameters
id
required
string

alert policy ID

conditionNum
required
integer

existing number of conditions element

Request Body schema:
required
description
string
required
Array of objects (MultipleValuesEntry)
object

Responses

Request samples

Content type
{
  • "description": "string",
  • "triggerConditions": [
    ],
  • "workingHours": {
    }
}

Response samples

Content type
{
  • "id": "",
  • "rev_id": "",
  • "relatedPolicies": [
    ],
  • "triggerConditions": [
    ],
  • "workingHours": {
    },
  • "description": "string",
  • "isAutomated": false,
  • "acceptingStatus": "NOT_YET_ACTIONED",
  • "modifiedBy": "string",
  • "createdBy": "string",
  • "createdTimestamp": 0,
  • "lastModifiedTimestamp": 0
}

createPolicyAllowList

creates an allow-list and attaches it to alert-policy's specified condition to triggersOn and recoversOn attributes both.

path Parameters
id
required
string

alert policy ID

conditionNum
required
integer

existing number of conditions element

Request Body schema:
required
description
string
required
Array of objects (MultipleValuesEntry)
object

Responses

Request samples

Content type
{
  • "description": "string",
  • "triggerConditions": [
    ],
  • "workingHours": {
    }
}

Response samples

Content type
{
  • "id": "",
  • "rev_id": "",
  • "relatedPolicies": [
    ],
  • "triggerConditions": [
    ],
  • "workingHours": {
    },
  • "description": "string",
  • "isAutomated": false,
  • "acceptingStatus": "NOT_YET_ACTIONED",
  • "modifiedBy": "string",
  • "createdBy": "string",
  • "createdTimestamp": 0,
  • "lastModifiedTimestamp": 0
}

deletePolicyAllowList

deletes an allowlist attached to policy.

path Parameters
id
required
string

alert policy ID

whitelistID
required
string

whitelist id

Responses

Response samples

Content type
{
  • "data": {
    }
}

Sets a custom tags as metadata of specific honeytrap agent

path Parameters
id
required
string

honey-trap agent ID

Request Body schema:
required
agent_id
required
string
_rev
string
tags
required
Array of strings

Responses

Request samples

Content type
{
  • "agent_id": "string",
  • "_rev": "string",
  • "tags": [
    ]
}

Response samples

Content type
{
  • "agent_id": "string",
  • "_rev": "string",
  • "tags": [
    ]
}

Returns all tags for all agent IDs

Responses

Response samples

Content type
{
  • "property1": {
    },
  • "property2": {
    }
}

Create an Alert Policy schedule entries set template

Request Body schema:
required
Array
object (workingWeekdays)
object (workingHoursRange)

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "id": "string",
  • "items": [
    ]
}

Get multiple Alert policy schedule items templates collections with pagination support

query Parameters
limit
integer >= 0
Default: 20

Maximum number of results to return

skip
integer >= 0

first N results skipped

Responses

Response samples

Content type
{
  • "data": [
    ],
  • "total": 0
}

Get single Alert policy schedule items set template, by it's ID

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "data": {
    }
}

Update single Alert policy schedule items set template, by it's ID

path Parameters
id
required
string
Request Body schema:
required
id
string
Array of objects (alertConditionWorkingHoursEntry)

Responses

Request samples

Content type
{
  • "id": "string",
  • "items": [
    ]
}

Response samples

Content type
{
  • "data": {
    }
}

Deletes schedule items set template, by it's ID

path Parameters
id
required
string

Responses

Response samples

Content type
"string"

Create an Alert Policy

Request Body schema:
required
required
object (alertPolicy)

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
{
  • "data": {
    }
}

Get all Alert Policies

query Parameters
useRawMetaKey
boolean
Default: false

Returns the raw metadata key's ID from the DB.

includeDeleted
boolean
Default: false

Include deleted policies in the results.

policyType
string

Only include policies of specified types.

tag
string

pass any tag substring for optional filtering alert policies by custom tag

Responses

Response samples

Content type
{
  • "meta": {
    },
  • "data": [
    ]
}

Get a specific default Alert Policy

path Parameters
id
required
string
query Parameters
useRawMetaKey
boolean
Default: false

Returns the default raw metadata key's ID from the DB.

Responses

Response samples

Content type
{
  • "data": {
    }
}

an api to be used to update alertPolicy with given ID with new status

path Parameters
id
required
string
query Parameters
val
required
string

acceptable values are "pending" or "running"

Responses

Response samples

Content type
"string"

Get the value of the default alert policies

query Parameters
useRawMetaKey
boolean
Default: false

Returns the default raw metadata key's ID from the DB.

Responses

Response samples

Content type
{
  • "meta": {
    },
  • "data": [
    ]
}

Patch automaticAlertPolicy

Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
{
  • "data": {
    }
}

Get Automatic Detection Policy

Responses

Response samples

Content type
{
  • "data": {
    }
}

Get a specific Alert Policy

path Parameters
id
required
string
query Parameters
useRawMetaKey
boolean
Default: false

Returns the raw metadata key's ID from the DB.

Responses

Response samples

Content type
{
  • "data": {
    }
}

Deletes an Alert Policy

Note that this does not physically delete a policy. It will become disabled and unmodifiable in order to provide references to existing alerts.

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "data": {
    }
}

Provides ability to patch a Alert Policy

path Parameters
id
required
string
query Parameters
force
string
Enum: false true

If a alert state is currently alarming, Skylight will block put updates if the force query parameter is not set to true.

Request Body schema:
required
required
object (alertPolicyRef)

identical to alertPolicy except conditions format

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
{
  • "data": {
    }
}

Gets all the history for a tenant

Please use the query parameters to limit the scope of the results. Otherwise, this will return all the raw alerts for a time interval

query Parameters
policyId
string

The Policy ID

interval
string

The interval in ISO 8601 standard but with the '/' replaced with '_'

monitoredObjectId
string

The monitored object alert history

alertState
string
Enum: "raised" "cleared"

Provide all the includes

policyType
string
Enum: "micro-tca" "anomaly" "capture" "capture-automatic" "percentage-violations" "baseline-percent"
limit
number

Maximum number of results to return

useRawMetaKey
boolean
Default: false

Returns the raw metadata key's ID from the DB.

category
string

Category to filter on

severity
string

severity to filter on

Responses

Response samples

Content type
{
  • "type": "alertHistories",
  • "id": "string",
  • "data": [
    ]
}

Retrieves specified aggregation grouped by the provided fields and filtered by the metadata specification

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Aggregates the provided metrics and filters them based on the provided criteria

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get the latest ramen state for a given tenant.

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{ }

TenantProvisioningServiceV2

Request Analytical analysis from Datahub

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get all currently stored Analytics Result Objects

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve an Analytics result by Id.

path Parameters
analyticsId
required
string

Unique identifier of an Analytics request in Datahub

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete an Analytics result by Id.

path Parameters
analyticsId
required
string

Unique identifier of an Analytics request in Datahub

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a Branding for a Tenant.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all Brandings for the specified Tenant.

query Parameters
zone
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant Branding by Id.

path Parameters
brandingId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Tenant Branding specified by the provided Branding Id.

path Parameters
brandingId
required
string
Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant Branding specified by the provided Branding Id.

path Parameters
brandingId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a Locale for a Tenant.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all Locales for the specified Tenant.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant Locale by Id.

path Parameters
localeId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Locale for a Tenant.

path Parameters
localeId
required
string
Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant Locale specified by the provided Locale Id.

path Parameters
localeId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a composite Metric for a Tenant.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all composite metrics for the specified Tenant.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a composite metric by Id.

path Parameters
CompositeMetricId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a composite metric specified by the provided Id.

path Parameters
CompositeMetricId
required
string
Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a composite metric specified by the provided Id.

path Parameters
CompositeMetricId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a ConnectorConfigTemplate for a Tenant.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all of the ConnectorConfigTemplates for the specified Tenant.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieves a connector configuration template by id.

path Parameters
templateId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Tenant ConnectorConfigTemplate specified by the provided Template Id.

path Parameters
templateId
required
string
Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant ConnectorConfigTemplate specified by the provided Template Id.

path Parameters
templateId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a Dashboard for a Tenant. Deprecated

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all Dashboards for the specified Tenant. Deprecated

query Parameters
zone
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant Dashboard by Id. Deprecated

path Parameters
dashboardId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Tenant Dashboard specified by the provided Dashboard Id. Deprecated

path Parameters
dashboardId
required
string
Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant Dashboard specified by the provided Dashboard Id. Deprecated

path Parameters
dashboardId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a Card for a Tenant. Deprecated

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all Cards for the specified Tenant. Deprecated

query Parameters
zone
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant Card by Id. Deprecated

path Parameters
cardId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Tenant Card specified by the provided Card Id. Deprecated

path Parameters
cardId
required
string
Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant Card specified by the provided Card Id. Deprecated

path Parameters
cardId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Provides ability to Create a Tenant Data Cleaning Profile

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all Data Cleaning Profiles for a Tenant.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Data Cleaning Profiles for a Tenant.

path Parameters
profileId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Provides ability to Update a Tenant Data Cleaning Profile

path Parameters
profileId
required
string
Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Data Cleaning Profile for a Tenant.

path Parameters
profileId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve data cleaning event history for a given monitored object and time period.

query Parameters
monitoredObjectId
required
string
interval
required
string

ISO-8601 Interval

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Download a roadrunner tarball ready for installing

query Parameters
zone
required
string

Responses

Download a roadrunner values yaml for use when helm installing roadrunner

query Parameters
zone
required
string
image
string

Responses

Create an Ingestion Profile for a Tenant.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "violations": [
    ]
}

Get all Tenant Ingestion Profiles

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant Ingestion Profile by id.

path Parameters
ingestionProfileId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "violations": [
    ]
}

Update a Tenant Ingestion Profile

path Parameters
ingestionProfileId
required
string
Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "violations": [
    ]
}

Delete a Tenant Ingestion Profile specified by the provided Ingestion Profile Id.

path Parameters
ingestionProfileId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "violations": [
    ]
}

Create a Metadata Configuration for a Tenant.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get all Tenant Metadata Configurations

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant Metadata Configuration by id.

path Parameters
MetadataConfigId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Tenant Metadata Configuration

path Parameters
MetadataConfigId
required
string
Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant Metadata Configuration specified by the provided Metadata Configuration Id.

path Parameters
MetadataConfigId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all Tenant Metric Baselines for a single Monitored Object.

path Parameters
monitoredObjectId
required
string
query Parameters
interval
string
directions
Array of strings
metrics
required
Array of strings

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve all Duplicate Monitored Object Reports for the specified Tenant.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Updates the DuplicateMonitoredObjectReport for the specified Tenant.

Responses

Response samples

Content type
application/vnd.api+json
"string"

Retrieve a Tenant Duplicate Monitored Object Report by Id.

path Parameters
duplicateMonitoredObjectResportId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a MonitoredObjectTagMapping for a Tenant.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all MonitoredObjectTagMappings for the specified Tenant.

query Parameters
zone
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant MonitoredObjectTagMapping by Id.

path Parameters
monitoredObjectTagMappingId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Tenant MonitoredObjectTagMapping specified by the provided MonitoredObjectTagMapping Id.

path Parameters
monitoredObjectTagMappingId
required
string
Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant MonitoredObjectTagMapping specified by the provided MonitoredObjectTagMapping Id.

path Parameters
monitoredObjectTagMappingId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all Monitored Objects for a Tenant.

query Parameters
start_key
string
Default: ""

Pagination key to start from for results to return, default to empty string. Ex: 2

limit
integer [ 1 .. 5000 ]
Default: 5000

The maximum number of records to return for a single page

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": [
    ]
}

Create a Monitored Object for a Tenant.

Request Body schema: application/vnd.api+json
required
required
object (MonitoredObjectCreate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": {
    }
}

Retrieve a count of monitored objects based on the provided filter criteria

query Parameters
group-by
string
Value: "object-type"
Request Body schema: application/json
required
objectNamePrefix
string
objectType
Array of strings
object (MetaFilter)

An object that allows filtering on arbitrary metadata criteria and their values. The keys in the map are associated with metadata categories and the value array corresponds to a set of whitelist filter-in values for that category. The logical semantics associated with this structure are conditional-AND across metadata criteria (keys) and conditional-OR across the values contained within the value array. For example, {"region":["montreal","ottawa"], "group":["radio"]} will match all records that are of group "radio" AND from the region "montreal" OR "ottawa"

metaExclude
Array of strings (MetaExclude)

An array that allows blacklisting one or more metadata criteria. Each key in the array must correspond to a given key in the MetaFilter portion of the request. This exclusion is a logical NOT for any values belonging to the metadata criteria listed in this request. For example, if the MetaFilter is: {"region":["montreal","ottawa"], "group":["radio"]}, we can have a MetaExclude of the form ["region"]. This would result in a request that includes any records that are of group "radio" AND NOT in regions Ottawa or Montreal.

object (TimeRange)

A time range specified by before and after in epoch time. Both before and after are inclusive to the specified value.

object (TimeRange)

A time range specified by before and after in epoch time. Both before and after are inclusive to the specified value.

object (GeoFence)
object (GeoFence)
topology
Array of strings

Responses

Request samples

Content type
application/json
{
  • "objectNamePrefix": "string",
  • "objectType": [
    ],
  • "meta": {
    },
  • "metaExclude": [
    ],
  • "archiveTimestamp": {
    },
  • "createdTimestamp": {
    },
  • "sourceLocation": {
    },
  • "destinationLocation": {
    },
  • "topology": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a list of monitored objects based on the provided filter criteria, in order to retreive all records pagination must be used.

query Parameters
start_key
string
Default: ""

Pagination key to start from for results to return, default to empty string. Ex: 2

limit
integer [ 1 .. 10000 ]
Default: 10000

The maximum number of records to return for a single page, default to 10,000.

Request Body schema: application/json
required
objectNamePrefix
string
objectType
Array of strings
object (MetaFilter)

An object that allows filtering on arbitrary metadata criteria and their values. The keys in the map are associated with metadata categories and the value array corresponds to a set of whitelist filter-in values for that category. The logical semantics associated with this structure are conditional-AND across metadata criteria (keys) and conditional-OR across the values contained within the value array. For example, {"region":["montreal","ottawa"], "group":["radio"]} will match all records that are of group "radio" AND from the region "montreal" OR "ottawa"

metaExclude
Array of strings (MetaExclude)

An array that allows blacklisting one or more metadata criteria. Each key in the array must correspond to a given key in the MetaFilter portion of the request. This exclusion is a logical NOT for any values belonging to the metadata criteria listed in this request. For example, if the MetaFilter is: {"region":["montreal","ottawa"], "group":["radio"]}, we can have a MetaExclude of the form ["region"]. This would result in a request that includes any records that are of group "radio" AND NOT in regions Ottawa or Montreal.

object (TimeRange)

A time range specified by before and after in epoch time. Both before and after are inclusive to the specified value.

object (TimeRange)

A time range specified by before and after in epoch time. Both before and after are inclusive to the specified value.

object (GeoFence)
object (GeoFence)
topology
Array of strings

Responses

Request samples

Content type
application/json
{
  • "objectNamePrefix": "string",
  • "objectType": [
    ],
  • "meta": {
    },
  • "metaExclude": [
    ],
  • "archiveTimestamp": {
    },
  • "createdTimestamp": {
    },
  • "sourceLocation": {
    },
  • "destinationLocation": {
    },
  • "topology": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": {
    }
}

Retrieve a list of monitored objects based on the provided reporting status criteria

Request Body schema: application/json
required
reportingObjects
boolean
Default: true

If true, the result will be a list of ids for monitored objects that are reporting. If false, the returned list will be monitored objects that are not reporting

numberOfDays
number <integer> [ 1 .. 31 ]
Default: 7

Number of days, from current time, to look in the past to determine if the Monitored Objects are reporting

Responses

Request samples

Content type
application/json
{
  • "reportingObjects": true,
  • "numberOfDays": 7
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": {
    }
}

Retrieve a count of monitored objects based on the provided reporting status criteria

Request Body schema: application/json
required
reportingObjects
boolean
Default: true

If true, the result will be a list of ids for monitored objects that are reporting. If false, the returned list will be monitored objects that are not reporting

numberOfDays
number <integer> [ 1 .. 31 ]
Default: 7

Number of days, from current time, to look in the past to determine if the Monitored Objects are reporting

Responses

Request samples

Content type
application/json
{
  • "reportingObjects": true,
  • "numberOfDays": 7
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve set of counts clustered by GeoHash identifiers specified by the open source GeoHashing algorithm.

query Parameters
precision
required
integer

The level of precision required for the geohashing grid

location
required
string
Enum: "source" "destination"

The location field that we want clustering based off of

Request Body schema: application/json
objectNamePrefix
string
objectType
Array of strings
object (MetaFilter)

An object that allows filtering on arbitrary metadata criteria and their values. The keys in the map are associated with metadata categories and the value array corresponds to a set of whitelist filter-in values for that category. The logical semantics associated with this structure are conditional-AND across metadata criteria (keys) and conditional-OR across the values contained within the value array. For example, {"region":["montreal","ottawa"], "group":["radio"]} will match all records that are of group "radio" AND from the region "montreal" OR "ottawa"

metaExclude
Array of strings (MetaExclude)

An array that allows blacklisting one or more metadata criteria. Each key in the array must correspond to a given key in the MetaFilter portion of the request. This exclusion is a logical NOT for any values belonging to the metadata criteria listed in this request. For example, if the MetaFilter is: {"region":["montreal","ottawa"], "group":["radio"]}, we can have a MetaExclude of the form ["region"]. This would result in a request that includes any records that are of group "radio" AND NOT in regions Ottawa or Montreal.

object (TimeRange)

A time range specified by before and after in epoch time. Both before and after are inclusive to the specified value.

object (TimeRange)

A time range specified by before and after in epoch time. Both before and after are inclusive to the specified value.

object (GeoFence)
object (GeoFence)
topology
Array of strings

Responses

Request samples

Content type
application/json
{
  • "objectNamePrefix": "string",
  • "objectType": [
    ],
  • "meta": {
    },
  • "metaExclude": [
    ],
  • "archiveTimestamp": {
    },
  • "createdTimestamp": {
    },
  • "sourceLocation": {
    },
  • "destinationLocation": {
    },
  • "topology": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a record of the provisioned metadata including the counts of Monitored Objects that use each metadata value

query Parameters
meta
Array of strings

List of metadata category names by which the request should be filtered. Currently exactly one metadata category must be provided, for multiple category results you must query separately for each respective category.

value-prefix
string

Prefix by which all metadata values names by should start

categories-only
boolean
Default: false

Flag to indicate if the response should include only the metadata category names (when set to true) or also include meta values and counts (when set to false)

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a record of the provisioned metadata including the counts of Monitored Objects that use each metadata value after being filtered by the passed in request body parameters, currently not supported.

Request Body schema: application/json
required
objectNamePrefix
string
objectType
Array of strings
object (MetaFilter)

An object that allows filtering on arbitrary metadata criteria and their values. The keys in the map are associated with metadata categories and the value array corresponds to a set of whitelist filter-in values for that category. The logical semantics associated with this structure are conditional-AND across metadata criteria (keys) and conditional-OR across the values contained within the value array. For example, {"region":["montreal","ottawa"], "group":["radio"]} will match all records that are of group "radio" AND from the region "montreal" OR "ottawa"

metaExclude
Array of strings (MetaExclude)

An array that allows blacklisting one or more metadata criteria. Each key in the array must correspond to a given key in the MetaFilter portion of the request. This exclusion is a logical NOT for any values belonging to the metadata criteria listed in this request. For example, if the MetaFilter is: {"region":["montreal","ottawa"], "group":["radio"]}, we can have a MetaExclude of the form ["region"]. This would result in a request that includes any records that are of group "radio" AND NOT in regions Ottawa or Montreal.

object (TimeRange)

A time range specified by before and after in epoch time. Both before and after are inclusive to the specified value.

object (TimeRange)

A time range specified by before and after in epoch time. Both before and after are inclusive to the specified value.

object (GeoFence)
object (GeoFence)
topology
Array of strings

Responses

Request samples

Content type
application/json
{
  • "objectNamePrefix": "string",
  • "objectType": [
    ],
  • "meta": {
    },
  • "metaExclude": [
    ],
  • "archiveTimestamp": {
    },
  • "createdTimestamp": {
    },
  • "sourceLocation": {
    },
  • "destinationLocation": {
    },
  • "topology": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a Tenant Monitored Object by id.

path Parameters
monObjId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": {
    }
}

Update a Tenant Monitored Object

path Parameters
monObjId
required
string
Request Body schema: application/vnd.api+json
required
required
object (MonitoredObjectUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": {
    }
}

Delete a Tenant Monitored Object specified by the provided id.

path Parameters
monObjId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": {
    }
}

Patches one or more Monitored Objects's based on the provided values

Request Body schema:
required
required
Array of objects (MonitoredObjectPatch)

Responses

Request samples

Content type
{
  • "data": [
    ]
}

Response samples

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

Create one or more Monitored Objects in a single API request.

Request Body schema:
required
required
Array of objects (MonitoredObjectCreate)

Responses

Request samples

Content type
{
  • "data": [
    ]
}

Response samples

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

Update one or more Monitored Objects in a single API request. Note that this is a PUT operation for each Monitored Object. This means that all properties must be explicitly provided

Request Body schema:
required
required
Array of objects (MonitoredObjectUpdate)

Responses

Request samples

Content type
{
  • "data": [
    ]
}

Response samples

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

Update the metadata of one or more Monitored Objects in a single API request.

Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

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

Retrieve all Monitored Object Summaries for a Tenant.

query Parameters
start_key
string

The name of the Monitored Object from which the result set will begin

limit
integer [ 1 .. 5000 ]
Default: 5000

The maximum number of records to return for a single page

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": [
    ]
}

Retrieve a Tenant Monitored Object Summary by the Monitored Object's id.

path Parameters
monObjId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": {
    }
}

Retrieve all Monitored Object Metadata Mappings for a Tenant.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": [
    ]
}

Retrieve a particular Tenant Monitored Object Metadata Mapping by the type of mapping.

path Parameters
mappingType
required
string
Enum: "unknown" "activeMetrics" "networkAssets"

The type of Metadata Category Mapping

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": {
    }
}

Update a particular Tenant Monitored Object Metadata Mapping by the type of mapping.

path Parameters
mappingType
required
string
Enum: "unknown" "activeMetrics" "networkAssets"

The type of Metadata Category Mapping to be updated

Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": {
    }
}

Create a SessionFilterProfile for a Tenant.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all SessionFilterProfiles for the specified Tenant.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant Dashboard by Id.

path Parameters
sessionFilterProfileId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Tenant SessionFilterProfile specified by the provided SessionFilterProfile Id.

path Parameters
sessionFilterProfileId
required
string
Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Patch a Tenant SessionFilterProfile specified by the provided SessionFilterProfile Id, with partial modifications.

path Parameters
sessionFilterProfileId
required
string
Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant SessionFilterProfile specified by the provided SessionFilterProfile Id.

path Parameters
sessionFilterProfileId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a SessionFilter for a Tenant.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all SessionFilters for the specified Tenant.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant SessionFilter by Id.

path Parameters
sessionFilterId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Tenant SessionFilter specified by the provided SessionFilter Id.

path Parameters
sessionFilterId
required
string
Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Patch a Tenant SessionFilter specified by the provided SessionFilter Id, with partial modifications.

path Parameters
sessionFilterId
required
string
Request Body schema:
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant SessionFilter specified by the provided SessionFilter Id.

path Parameters
sessionFilterId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a Threshold Profile for a Tenant. Deprecated

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all Threshold Profiles for the specified Tenant. Deprecated

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant Threshold Profile by id. Deprecated

path Parameters
thrPrfId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Tenant Threshold Profile Deprecated

path Parameters
thrPrfId
required
string
Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant Threshold Profile specified by the provided id. Deprecated

path Parameters
thrPrfId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a ConnectorConfig for a Tenant.

header Parameters
X-Forwarded-Tenant-Id
required
string
Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all ConnectorConfigs for the specified Tenant.

query Parameters
zone
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant ConnectorConfig by Id.

path Parameters
connectorId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Tenant ConnectorConfig specified by the provided Connector Id.

path Parameters
connectorId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string
Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant ConnectorConfig specified by the provided Connector Id.

path Parameters
connectorId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

TenantCyberSecurityNetworkAssetServiceV2

Create a Network Asset

Request Body schema: application/vnd.api+json
required
required
object (NetworkAsset)

A network device that is on a customer's network

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all NetworkAssets for a Tenant.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retrieve a Network Asset by its ID

path Parameters
networkAssetId
required
string

The network asset id

Responses

Response samples

Content type
{
  • "data": {
    }
}

Update a Tenant Network Asset

path Parameters
networkAssetId
required
string

The network asset id

Request Body schema: application/vnd.api+json
required
required
object (NetworkAsset)

A network device that is on a customer's network

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant Network Asset specified by the provided id.

path Parameters
networkAssetId
required
string

The network asset id

Responses

Response samples

Content type
application/vnd.api+json
"string"

Retrieve a count of monitored objects based on the provided filter criteria

Request Body schema: application/json
required
search
string

A field value to search with a wildcard in different fields of the asset

object (NetworkAssetQueryContext)

Hints indicating how the query may be returned

ip
Array of strings

An array of IPs

mac
Array of strings

An array of MACs

object (TimeRangeInMilliseconds)
object (TimeRangeInMilliseconds)
captureZones
Array of strings

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "queryContext": {
    },
  • "ip": [
    ],
  • "mac": [
    ],
  • "firstSeen": {
    },
  • "lastSeen": {
    },
  • "captureZones": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a list of monitored objects based on the provided filter criteria

Request Body schema: application/json
required
search
string

A field value to search with a wildcard in different fields of the asset

object (NetworkAssetQueryContext)

Hints indicating how the query may be returned

ip
Array of strings

An array of IPs

mac
Array of strings

An array of MACs

object (TimeRangeInMilliseconds)
object (TimeRangeInMilliseconds)
captureZones
Array of strings

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "queryContext": {
    },
  • "ip": [
    ],
  • "mac": [
    ],
  • "firstSeen": {
    },
  • "lastSeen": {
    },
  • "captureZones": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retrieves specified aggregation grouped by the provided fields and filtered by the metadata specification

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a list of countries for provided assets

Request Body schema: application/json
required
ips
Array of strings

An array of IPs

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

TenantIncidentsV2

Retrieve incidents based on the provided filter criterea

Request Body schema:
required
object
object (expressions)
object (MetaFilter)

An object that allows filtering on arbitrary metadata criteria and their values. The keys in the map are associated with metadata categories and the value array corresponds to a set of whitelist filter-in values for that category. The logical semantics associated with this structure are conditional-AND across metadata criteria (keys) and conditional-OR across the values contained within the value array. For example, {"region":["montreal","ottawa"], "group":["radio"]} will match all records that are of group "radio" AND from the region "montreal" OR "ottawa"

id
Array of strings
alias
Array of strings
state
Array of strings
Items Enum: "new" "in-progress" "resolved" "closed" "archived"
object (TimeRangeInMilliseconds)
object (TimeRangeInMilliseconds)

Responses

Request samples

Content type
{
  • "queryContext": {
    },
  • "expressions": {
    },
  • "meta": {
    },
  • "id": [
    ],
  • "alias": [
    ],
  • "state": [
    ],
  • "createdAt": {
    },
  • "modifiedAt": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "meta": {
    }
}

Retrieve a single incident based on the provided ID

path Parameters
incidentId
required
string
query Parameters
includeRelatedAlerts
boolean
Default: false

Responses

Response samples

Content type
{
  • "data": {
    }
}

Update an incident

path Parameters
incidentId
required
string
Request Body schema:
required
required
object (Incident)

A collection of correlated alerts

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
{
  • "data": {
    }
}

Update the state of incidents with provided IDs

Request Body schema:
required
targetIncidents
required
Array of strings

A list of IDs of incidents to change state of

newState
required
string
Enum: "new" "in-progress" "resolved" "closed" "archived"
comment
string

Responses

Request samples

Content type
{
  • "targetIncidents": [
    ],
  • "newState": "new",
  • "comment": "string"
}

Response samples

Content type
{
  • "data": [
    ],
  • "meta": {
    }
}

Retrieves specified aggregation grouped by the provided fields and filtered by the metadata specification

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

ManagerV2

Bootstraps the monitored object cache for all tenants

Responses

Response samples

Content type
"string"

Invokes baseline bulk update

Responses

Response samples

Content type
"string"

Purges analytics reports

Responses

Response samples

Content type
"string"

Bootstraps the network asset cache for all tenants

Responses

Response samples

Content type
"string"

TenantThreatFeedV2

Retrieve threat feeds metadata

Responses

Response samples

Content type
{
  • "data": [
    ],
  • "meta": {
    }
}

Create a threat feed metadata and save content

Request Body schema:
required
required
object (ThreatFeed)

A dataset with malicious IPs, hashes, domains

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "meta": {
    }
}

Retrieve threat feeds metadata

path Parameters
threatFeedId
required
string

Responses

Response samples

Content type
{
  • "data": {
    }
}

Delete threat feeds metadata

path Parameters
threatFeedId
required
string

Responses

Response samples

Content type
{
  • "data": {
    }
}

Update a threat feed metadata

path Parameters
threatFeedId
required
string
Request Body schema:
required
required
object (ThreatFeed)

A dataset with malicious IPs, hashes, domains

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
{
  • "data": {
    }
}

Set last updated timestamp for public a threat feed

path Parameters
threatFeedId
required
string
Request Body schema:
required
updatedTimestamp
integer <int64>

Responses

Request samples

Content type
{
  • "updatedTimestamp": 0
}

Response samples

Content type
{
  • "data": [
    ],
  • "meta": {
    }
}

Upload a threat feed content

path Parameters
threatFeedId
required
string
Request Body schema: multipart/form-data
required
file
required
string <binary>

Responses

Response samples

Content type
{
  • "data": {
    }
}

TenantProvisioningServiceV3

Create an AlertExport for a Tenant.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all AlertExports for the specified Tenant.

query Parameters
zone
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant AlertExport by Id.

path Parameters
alertexportId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Tenant AlertExport specified by the provided AlertExport Id.

path Parameters
alertexportId
required
string
Request Body schema:
required
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Tenant AlertExport specified by the provided AlertExport Id.

path Parameters
alertexportId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Upsert an ingestion dictionary using 'append only' rules

Request Body schema: application/vnd.api+json
required
required
object (IngestionDictionaryV3)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "violations": [
    ]
}

Update Dynamic Metadata Dimension mappings for a Tenant. Fields to be disabled should be marked with `IsActive:false`

Request Body schema: application/vnd.api+json
required
required
object (DynamicMetadataDimensionMappings)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get Dynamic Metadata Mappings

query Parameters
includeOnlyActive
boolean
Default: false

Returns only active dynamic meta-data mappings.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create an Ingestion Dictionary for a Tenant.

Request Body schema: application/vnd.api+json
required
required
object (IngestionDictionaryV3)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "violations": [
    ]
}

Get all Tenant Ingestion Dictionaries

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Get all global Ingestion Dictionaries

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant Ingestion Dictionary by id.

path Parameters
IngestionDictionaryId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "violations": [
    ]
}

Update a Tenant Ingestion Dictionary

path Parameters
IngestionDictionaryId
required
string
Request Body schema: application/vnd.api+json
required
required
object (IngestionDictionaryV3)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "violations": [
    ]
}

Delete a Tenant Ingestion Dictionary specified by the provided Ingestion Dictionary Id.

path Parameters
IngestionDictionaryId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "violations": [
    ]
}

Create an Staged Ingestion Dictionary for a Tenant.

Request Body schema: application/vnd.api+json
required
required
object (IngestionDictionaryV3)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "violations": [
    ]
}

Get all Tenant Staged Ingestion Dictionaries

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a Tenant's Staged Ingestion Dictionary by id.

path Parameters
IngestionDictionaryId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "violations": [
    ]
}

Update a Tenant's Staged Ingestion Dictionary

path Parameters
IngestionDictionaryId
required
string
Request Body schema: application/vnd.api+json
required
required
object (IngestionDictionaryV3)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "violations": [
    ]
}

Delete a Tenant's Staged Ingestion Dictionary specified by the provided Ingestion Dictionary Id.

path Parameters
IngestionDictionaryId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "violations": [
    ]
}

Dependencies

Returns a list of activated dependencies

Responses

Response samples

Content type
{
  • "data": {
    }
}

MetricsServiceV3

Retrieves specified aggregation grouped by the provided fields and filtered by the metadata specification

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Aggregates the provided metrics and filters them based on the provided criteria

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Re-ingests data into the datasource given the input parameters

path Parameters
datasource
required
string
query Parameters
taskCount
integer >= 1

Sets the concurrency level of the ingestion task

maxSizePerTask
integer <int64> >= 1
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Re-formats data in the datasource to optomize the datasource

path Parameters
datasource
required
string
query Parameters
taskCount
integer >= 1
Default: 1

Sets the concurrency level of the granularity compaction task

maxSizePerTask
integer <int64> >= 1

Sets the amount of data each task can process. Used to control the number of tasks that will be created up to max value of 'taskCount'

periodOffsetMultiplier
integer
Default: 0

Used to generate reindexing tasks over a period from current time backwards based on the 'c' provided in the body. For example, 'targetSegmentTimebucket' of 'DAY' with 'periodOffsetMultiplier' of '5' invokes daily reindexing from [NOW-5days, NOW).

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieves specified aggregation grouped by the provided fields and filtered by the metadata specification

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Retrieves specified aggregation grouped by the provided fields and filtered by the metadata specification

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Aggregates the provided metrics and filters them based on the provided criteria

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Aggregates the provided metrics and filters them based on the provided criteria

path Parameters
monitoredObjectId
required
string
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Retrieves specified aggregation grouped by the provided fields and filtered by the metadata specification

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Retrieve all Segment Routing for RA instance runs matching the specific segmentId, and stateId (if specified) for a tenant.

path Parameters
segmentId
required
string

ID of the segment

query Parameters
stateId
string

stateId of the segment routing RA instance

interval
required
string

Interval over which to execute the granularity compaction. eg: 2024-10-23T23:52:52.756Z/2024-10-24T00:07:22.755Z

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieves metrics pertaining to a given path, both as a total against the path and broken down by the individual links composing the path

What-if retrieval: Specifying a sequence of links is specified in addition to a source a destination, then the metrics for all individual links are returned in the order specified. This requires that each individual links specified are already known by this system. This is useful to run "What-if" scenarios (for instance, finding out the power usage or CO2 footprint of an hypothetical path that was not yet provisioned.

The time range and the aggregation function to apply over the time range must be specified (min,max,avg).

The metrics array is used to identify which metrics to return. Leaving it empty returns all metrics available for that link

Request Body schema: application/vnd+json
required
required
object (PathRequestMetricsData)

Responses

Request samples

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

Response samples

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

InstanceMetricsApiV3

Retrieve all instance metric runs having the specific monitoredObjectId and reportType within a specified interval for a tenant.

path Parameters
monitoredObjectId
required
string

ID of the monitoredObject

reportType
required
string
Enum: "interval" "summary"

Instance's reportType filter

query Parameters
start
required
string <date-time>

Beginning of interval of runs returned

end
required
string <date-time>

End of interval of runs returned

cursor
string

Use to traverse multiple "pages" of results

size
integer [ 1 .. 10000 ]

Set/override the number of records returned in the response's payload

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": [
    ]
}

Retrieve all instance metric runs matching the specific monitoredObjectId, reportType and runId for a tenant.

path Parameters
monitoredObjectId
required
string

ID of the monitoredObject

reportType
required
string
Enum: "interval" "summary"

Instance's reportType filter

runId
required
string

RunId of the instance-metric

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": [
    ]
}

TenantAlertServiceV3

Get the value of the default alert policies

query Parameters
useRawMetaKey
boolean
Default: false

Returns the default raw metadata key's ID from the DB.

Responses

Response samples

Content type
{
  • "meta": {
    },
  • "data": [
    ]
}

Get a specific default Alert Policy

path Parameters
id
required
string
query Parameters
useRawMetaKey
boolean
Default: false

Returns the default raw metadata key's ID from the DB.

Responses

Response samples

Content type
{
  • "data": {
    }
}

Generate condition rule based on provided alert

query Parameters
alertId
required
string

required id of alert

Responses

Response samples

Content type
{
  • "id": "",
  • "rev_id": "",
  • "relatedPolicies": [
    ],
  • "triggerConditions": [
    ],
  • "workingHours": {
    },
  • "description": "string",
  • "isAutomated": false,
  • "acceptingStatus": "NOT_YET_ACTIONED",
  • "modifiedBy": "string",
  • "createdBy": "string",
  • "createdTimestamp": 0,
  • "lastModifiedTimestamp": 0
}

Get multiple Alert policy condition rule objects with pagination support

query Parameters
limit
integer >= 0
Default: 25

Maximum number of results to return

skip
integer >= 0

first N results skipped

policyID
string

optional id of related policy

policyName
string

optional name substring of related policy

description
string

optional condition-rule description substring

acceptingStatus
string

optional filter for acceptingStatus property

Responses

Response samples

Content type
{
  • "data": [
    ],
  • "total": 0
}

Gets a single Alert Policy whitelist by specified ID

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "data": {
    }
}

Gets a single Alert Policy whitelist by specified ID

path Parameters
id
required
string
Request Body schema:
required
id
string
Default: ""
rev_id
string
Default: ""
relatedPolicies
Array of strings
required
Array of objects (MultipleValuesEntry)
object (alertConditionWorkingHoursSet)
description
string
isAutomated
boolean
Default: false
acceptingStatus
string
Enum: "NOT_YET_ACTIONED" "ACCEPTED" "REJECTED" "NOT_AUTOMATED"
modifiedBy
string
createdBy
string
createdTimestamp
integer <int64>
lastModifiedTimestamp
integer <int64>

Responses

Request samples

Content type
{
  • "id": "",
  • "rev_id": "",
  • "relatedPolicies": [
    ],
  • "triggerConditions": [
    ],
  • "workingHours": {
    },
  • "description": "string",
  • "isAutomated": false,
  • "acceptingStatus": "NOT_YET_ACTIONED",
  • "modifiedBy": "string",
  • "createdBy": "string",
  • "createdTimestamp": 0,
  • "lastModifiedTimestamp": 0
}

Response samples

Content type
{
  • "data": {
    }
}

Accept or decline the automatically generated condition rule

path Parameters
id
required
string
Request Body schema:
required
acceptingStatus
required
string
Enum: "ACCEPTED" "REJECTED"

Responses

Request samples

Content type
{
  • "acceptingStatus": "ACCEPTED"
}

Response samples

Content type
{
  • "id": "",
  • "rev_id": "",
  • "relatedPolicies": [
    ],
  • "triggerConditions": [
    ],
  • "workingHours": {
    },
  • "description": "string",
  • "isAutomated": false,
  • "acceptingStatus": "NOT_YET_ACTIONED",
  • "modifiedBy": "string",
  • "createdBy": "string",
  • "createdTimestamp": 0,
  • "lastModifiedTimestamp": 0
}

Migrate the whitelist to a new format

Responses

Response samples

Content type
"string"

TenantPredictionServiceV3

Provides ability to create a tenant prediction profile

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve prediction profile for a tenant.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete the Prediction Profile for a Tenant.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

TcpThroughputTestReportServiceV3

Create a TCP Throughput test report

Request Body schema: application/vnd.api+json
required
required
object (TcpThroughputTestReport)

A single instance of a TCP Throughput test run.

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all TCP Throughput test run reports for a tenant.

query Parameters
shallow
boolean

If set, retrieve only summary kpi's for the test records

token
string

For paginated results, the token to receive the next batch of results

Responses

Response samples

Content type
application/vnd.api+json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Retrieve all TCP Throughput test reports for a test instance.

path Parameters
testId
required
string

The test identifier

query Parameters
shallow
boolean

If set, retrieve only summary kpi's for the test records

token
string

For paginated results, the token to receive the next batch of results

Responses

Response samples

Content type
{
  • "pagination": {
    },
  • "data": [
    ]
}

Retrieve a TCP Throughput test report by test id and run id

path Parameters
testId
required
string

The test identifier

runId
required
string

The id associated with a particular test run

query Parameters
shallow
boolean

If set, retrieve only summary kpi's for the test record

Responses

Response samples

Content type
{
  • "pagination": {
    },
  • "data": [
    ]
}

Update a TCP Throughput test report

path Parameters
testId
required
string

The test identifier

runId
required
string

The is associated with a particular test run

Request Body schema: application/vnd.api+json
required
required
object (TcpThroughputUpdateBody)

A single instance of a TCP Throughput test run.

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a TCP Throughput Test report specified by the provided test id and run id.

path Parameters
testId
required
string

The test identfifier

runId
required
string

The id associated with a particular test run

Responses

Response samples

Content type
application/vnd.api+json
"string"

Retrieve a count of TCP Throughput test reports based on the provided filter criteria

Request Body schema: application/json
required
object (expressions)
object (MetaFilter)

An object that allows filtering on arbitrary metadata criteria and their values. The keys in the map are associated with metadata categories and the value array corresponds to a set of whitelist filter-in values for that category. The logical semantics associated with this structure are conditional-AND across metadata criteria (keys) and conditional-OR across the values contained within the value array. For example, {"region":["montreal","ottawa"], "group":["radio"]} will match all records that are of group "radio" AND from the region "montreal" OR "ottawa"

object (MetaFilter)

An object that allows filtering on arbitrary metadata criteria and their values. The keys in the map are associated with metadata categories and the value array corresponds to a set of whitelist filter-in values for that category. The logical semantics associated with this structure are conditional-AND across metadata criteria (keys) and conditional-OR across the values contained within the value array. For example, {"region":["montreal","ottawa"], "group":["radio"]} will match all records that are of group "radio" AND from the region "montreal" OR "ottawa"

metaExclude
Array of strings (MetaExclude)

An array that allows blacklisting one or more metadata criteria. Each key in the array must correspond to a given key in the MetaFilter portion of the request. This exclusion is a logical NOT for any values belonging to the metadata criteria listed in this request. For example, if the MetaFilter is: {"region":["montreal","ottawa"], "group":["radio"]}, we can have a MetaExclude of the form ["region"]. This would result in a request that includes any records that are of group "radio" AND NOT in regions Ottawa or Montreal.

test-id
Array of strings

An array of test identifiers

run-id
Array of strings

An array of run identifiers

Responses

Request samples

Content type
application/json
{
  • "expressions": {
    },
  • "user-meta": {
    },
  • "ingestion-meta": {
    },
  • "metaExclude": [
    ],
  • "test-id": [
    ],
  • "run-id": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a list of TCP Throughput test reports based on the provided filter criteria

query Parameters
shallow
boolean

If set, retrieve only summary kpi's for the test record

token
string
Request Body schema: application/json
object (expressions)
object (MetaFilter)

An object that allows filtering on arbitrary metadata criteria and their values. The keys in the map are associated with metadata categories and the value array corresponds to a set of whitelist filter-in values for that category. The logical semantics associated with this structure are conditional-AND across metadata criteria (keys) and conditional-OR across the values contained within the value array. For example, {"region":["montreal","ottawa"], "group":["radio"]} will match all records that are of group "radio" AND from the region "montreal" OR "ottawa"

object (MetaFilter)

An object that allows filtering on arbitrary metadata criteria and their values. The keys in the map are associated with metadata categories and the value array corresponds to a set of whitelist filter-in values for that category. The logical semantics associated with this structure are conditional-AND across metadata criteria (keys) and conditional-OR across the values contained within the value array. For example, {"region":["montreal","ottawa"], "group":["radio"]} will match all records that are of group "radio" AND from the region "montreal" OR "ottawa"

metaExclude
Array of strings (MetaExclude)

An array that allows blacklisting one or more metadata criteria. Each key in the array must correspond to a given key in the MetaFilter portion of the request. This exclusion is a logical NOT for any values belonging to the metadata criteria listed in this request. For example, if the MetaFilter is: {"region":["montreal","ottawa"], "group":["radio"]}, we can have a MetaExclude of the form ["region"]. This would result in a request that includes any records that are of group "radio" AND NOT in regions Ottawa or Montreal.

test-id
Array of strings

An array of test identifiers

run-id
Array of strings

An array of run identifiers

Responses

Request samples

Content type
application/json
{
  • "expressions": {
    },
  • "user-meta": {
    },
  • "ingestion-meta": {
    },
  • "metaExclude": [
    ],
  • "test-id": [
    ],
  • "run-id": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "pagination": {
    },
  • "data": [
    ]
}

TelemetryAgentTemplates

Create telemetry agent template

Request Body schema:
required

The telemetry agent template

name
required
string non-empty
templateBase64
string

This string contains telegraf's configuration encoded in base64, use this this field if you don't want to divide configuration into input and transformation parts.

type
string
Default: ""
Enum: "input" "transformation" ""

Responses

Request samples

Content type
{
  • "name": "string",
  • "templateBase64": "string",
  • "type": "input"
}

Response samples

Content type
{
  • "name": "string",
  • "templateBase64": "string",
  • "type": "input",
  • "templateVersion": 0
}

Retrieve telemetry agent templates from the repository

query Parameters
limit
integer >= 0
Default: 1000

Maximum number of results to return

skip
integer >= 0
Default: 0

first N results skipped

name
string

The name for the template to retrieve

type
string
Default: ""
Enum: "input" "transformation" ""

Responses

Response samples

Content type
{
  • "data": [
    ]
}

Deletes the specified template from the repository.

path Parameters
name
required
string

The unique name

Responses

Retrieve telemetry agent template document from the repository

path Parameters
name
required
string

The unique name

Responses

Response samples

Content type
{
  • "name": "string",
  • "templateBase64": "string",
  • "type": "input",
  • "templateVersion": 0
}

Updates an existing template in the repository. Works in 2 modes, in default update is performed and latest version is stored in history. In second mode when parameter overwrite_version is used a specific version is overwritten.

path Parameters
name
required
string

The unique name

Request Body schema:
required

The template

templateBase64
string

This string contains telegraf's configuration encoded in base64, use this this field if you don't want to divide configuration into input and transformation parts.

type
string
Default: ""
Enum: "input" "transformation" ""

Responses

Request samples

Content type
{
  • "templateBase64": "string",
  • "type": "input"
}

Response samples

Content type
{
  • "errors": [
    ]
}

Builds agent configuration with telemetry agent template

path Parameters
name
required
string

The unique name

Request Body schema:
required

Agent configuration parameters

required
object (DataGateway)

Data gateway (roadrunner) access parameters

IdentificationAgentName
string
MetadataAgentName
string

Responses

Request samples

Content type
{
  • "DataGateway": {
    },
  • "IdentificationAgentName": "string",
  • "MetadataAgentName": "string"
}

Builds agent configuration with telemetry agent template

path Parameters
nameInput
required
string

Name of the input template

nameTransformation
required
string

Name of the transformation template

Request Body schema:
required

Agent configuration parameters

required
object (DataGateway)

Data gateway (roadrunner) access parameters

IdentificationAgentName
string
MetadataAgentName
string

Responses

Request samples

Content type
{
  • "DataGateway": {
    },
  • "IdentificationAgentName": "string",
  • "MetadataAgentName": "string"
}

TenantMonitoringServiceV3

Get all operational states for a connector

path Parameters
ConnectorId
required
string
query Parameters
size
integer >= 1
Default: 1
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Create a connector's new operational state.

path Parameters
ConnectorId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string
Request Body schema: application/vnd.api+json
required
required
object (NewConnectorOperationalState)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve a connector's operational state by id.

path Parameters
ConnectorId
required
string
OperationalStateId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get all connectors

query Parameters
zone
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve a connector by id.

path Parameters
ConnectorId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Activate requested connector and deactivate currently active connector. Only supported when high availability is enabled.

path Parameters
ConnectorId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
"string"

TechSupportReportServiceV3

Create a tech support request that will be sent to connector.

path Parameters
ConnectorId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string
Request Body schema: application/vnd.api+json
required
name
string

Report name. Can help idientify it later. If not provided will be set as uuid.

generationTimeoutMinutes
integer <int64>

Time after which report generation process will be canceled. If not specified default will be set.

Responses

Request samples

Content type
application/vnd.api+json
{
  • "name": "string",
  • "generationTimeoutMinutes": 0
}

Response samples

Content type
application/vnd.api+json
{
  • "id": "string",
  • "connectorId": "string",
  • "connectorZone": "string",
  • "statusUri": "string"
}

Cancels tech support request that has been started.

path Parameters
ConnectorId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "message": "string"
}

Get all tech support reports generated by a connector with status included

path Parameters
ConnectorId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "zone": "string",
  • "connectorId": "string",
  • "reports": [
    ]
}

Get specific tech support report generated by a connector

path Parameters
ConnectorId
required
string
ReportId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "reportId": "string",
  • "reportName": "string",
  • "report": "string",
  • "connectorId": "string",
  • "generationTime": 0
}

Remove specific tech support report generated by a connector

path Parameters
ConnectorId
required
string
ReportId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "reportId": "string",
  • "reportName": "string",
  • "report": "string",
  • "connectorId": "string",
  • "generationTime": 0
}

Get specific tech support report status

path Parameters
ConnectorId
required
string
ReportId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "reportId": "string",
  • "reportName": "string",
  • "status": "Requested",
  • "info": "string",
  • "issuedAt": 0,
  • "zone": "string",
  • "connectorId": "string",
  • "reportUri": "string"
}

SessionTraceProvisioningServiceV1

Create a session-trace config for a particular Tenant and objectId .

header Parameters
X-Forwarded-Tenant-Id
required
string
Request Body schema: application/vnd.api+json
required
required
object (NewSessionTraceCreateRequest)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "sessionTraceId": "string",
  • "tenantId": "string",
  • "filter": [
    ],
  • "zone": [
    ],
  • "enable": true,
  • "reportDuration": 0,
  • "reportInterval": 0,
  • "createdTimestamp": 0
}

Get a list of all the session-trace configs for a tenant.

header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Get a session-trace config specified by the sessionTraceId.

path Parameters
sessionTraceId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "sessionTraceId": "string",
  • "tenantId": "string",
  • "filter": [
    ],
  • "zone": [
    ],
  • "enable": true,
  • "reportDuration": 0,
  • "reportInterval": 0,
  • "createdTimestamp": 0
}

Delete a Tenant session-trace config specified by the sessionTraceId.

path Parameters
sessionTraceId
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "sessionTraceId": "string",
  • "tenantId": "string",
  • "filter": [
    ],
  • "zone": [
    ],
  • "enable": true,
  • "reportDuration": 0,
  • "reportInterval": 0,
  • "createdTimestamp": 0
}