diff --git a/index.html b/index.html index 6a0d0096..40f6cffc 100644 --- a/index.html +++ b/index.html @@ -2442,7 +2442,7 @@ -
SpotByNetAppLogo
API docs by Redocly
SpotByNetAppLogo
API docs by Redocly
Authorizations:
auth
query Parameters
accountId
string
Example: accountId=act-123abc

ID of the account associated with your token

Request Body schema: application/json
One of
required
object

Object defining the subscription parameters

endpoint
required
string

The endpoint the notification will be sent to. url in case of http/https/web, email address in case of email/email-json and sns-topic-arn in case of aws-sns. -For example: YOUR@EMAIL.COM or https://YOUR_ENDPOINT.COM or SNS_TOPIC_ARN

+For example: YOUR@EMAIL.COM or https://YOUR_ENDPOINT.COM or SNS_TOPIC_ARN

object

The format of the notification content (JSON Format: Key + Value). The keys can be renamed.

eventType
required
string
Enum: "AWS_EC2_INSTANCE_TERMINATE" "AWS_EC2_INSTANCE_TERMINATED" "AWS_EC2_INSTANCE_LAUNCH" "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT" "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT" "AWS_EC2_CANT_SPIN_OD" "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB" "GROUP_ROLL_FAILED" "GROUP_ROLL_FINISHED" "CANT_SCALE_UP_GROUP_MAX_CAPACITY" "GROUP_UPDATED" "AWS_EMR_PROVISION_TIMEOUT" "GROUP_BEANSTALK_INIT_READY" "AZURE_VM_TERMINATED" "AZURE_VM_TERMINATE" "AWS_EC2_MANAGED_INSTANCE_PAUSING" "AWS_EC2_MANAGED_INSTANCE_RESUMING" "AWS_EC2_MANAGED_INSTANCE_RECYCLING" "AWS_EC2_MANAGED_INSTANCE_DELETING"

The event to send the notification when triggered.

@@ -5836,56 +5836,75 @@
workspace_id
string

currently selected Workspace ID

Responses

Connect Settings

API to fetch list of API Keys

Authorizations:
auth
query Parameters
disable_redact
string

Disable redacting API keys

+

Connect Settings

List API Keys

Endpoint to fetch list of API Keys and its values.

+
Authorizations:
auth
query Parameters
disable_redact
string

Disable redacting API keys

workspace_id
string

Currently selected Workspace ID

-

Responses

Responses

API to delete an API Key

Authorizations:
auth
path Parameters
apikey_name
required
string

API key name

+

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Delete API Key

Endpoint to delete an API Key.

+
Authorizations:
auth
path Parameters
apikey_name
required
string

API key name

query Parameters
workspace_id
string

Currently selected Workspace ID

-

Responses

Responses

API to fetch an API Key with given name in a given workspace

Authorizations:
auth
path Parameters
apikey_name
required
string

API key name

+

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Get API Key

Endpoint to fetch the selected API key's information from the selected workspace.

+
Authorizations:
auth
path Parameters
apikey_name
required
string

API key name

query Parameters
disable_redact
string

Disable redacting API keys

workspace_id
string

Currently selected Workspace ID

-

Responses

Responses

API to create a new API Key

Authorizations:
auth
path Parameters
apikey_name
required
string

API key name

+

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Create API Key

Endpoint to create a new API Key.

+
Authorizations:
auth
path Parameters
apikey_name
required
string

API key name

query Parameters
workspace_id
string

Currently selected Workspace ID

-

Responses

Responses

move the apikey_name to the new workspace

Authorizations:
auth
path Parameters
apikey_name
required
string

API key name

+

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Update API Key

Move the API key to the new workspace.

+
Authorizations:
auth
path Parameters
apikey_name
required
string

API key name

query Parameters
workspace_id
string

Currently selected Workspace ID

-

Responses

Responses

Checks whether given Alias name is available for use

for specific service in specific organization -Expected payload:- -{ - "alias": "" -}

+

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Get Alias Name Availability

Checks whether given Alias name is available for use +for the selected service in the current organization.

Authorizations:
auth
path Parameters
service
required
string

Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)

-

Responses

Request Body schema: application/json
alias
required
string

The alias to check availability for.

+

Responses

Get a list of all the enabled connectors (integration or resource), excluding those

that are TRIGGER_ONLY. For each connector, obtain some basic settings from its schema, -and calculate a boolean status indicating whether it is configured or not. -A connector is NOT configured if no tenant secret data is stored in the TenantSecretsDb.

+

Request samples

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

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

List Enabled Connectors

Retrieve a list of all enabled connectors (integration or resource), excluding those that are +exclusively trigger-based. For each connector, extract essential settings from its schema and +determine a boolean status indicating whether it's configured or not.

Authorizations:
auth
query Parameters
workspace_id
string

Currently selected Workspace ID

-

Responses

Responses

POST Api for status of Jira OAuth approval by Customer (Jira administrator)

Authorizations:
auth
query Parameters
workspace_id
string

Currently selected Workspace ID

-

Responses

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Authenticate Jira Integration

API for status of Jira OAuth approval by Customer (Jira administrator).

+
Authorizations:
auth
query Parameters
alias
string

Slack integration alias.

+
jira_url
string

URL of the Jira instance.

+
req_token
string

The request token provided by Jira for the integration.

+
req_token_secret
string

The request token secret provided by Jira for the integration.

+
workspace_id
string

Currently selected Workspace ID

+

Responses

This API is used to fetch Jira authorization URL

Authorizations:
auth

Responses

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Get Jira Authorization URL

This API is used to fetch Jira authorization URL.

+
Authorizations:
auth
query Parameters
alias
string

Slack integration alias.

+
jira_url
string

URL of the Jira instance.

+

Responses

Gets various Fylamynt plan details with quotas and pricing

Authorizations:
auth

Responses

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Get Spot Connect Plans

Fetch various Spot Connect plan details with quotas and pricing.

+
Authorizations:
auth

Responses

Returns a list of public IPs

Authorizations:
auth

Responses

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

List Public IPs

Returns a list of public IPs for customers to whitelist.

+
Authorizations:
auth

Responses

Gets the various quotas and outputs the limits and current state

Authorizations:
auth

Responses

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Get Quotas

Fetch quotas for organization and provide information on their limits and current status.

+
Authorizations:
auth

Responses

Get the jsonschema for the given service settings

Authorizations:
auth
path Parameters
service
required
string

Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)

-

Responses

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Get Schema

Get the JSON schema for the given integration or resource.

+
Authorizations:
auth
path Parameters
service
required
string

Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)

+

Responses

After the user installs/authorizes the Fylamynt Slack app in their workspace,

they will be redirected back to the Slack integration page in the Fylamynt web app +

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Authenticate Slack Integration

After the user installs/authorizes the Spot Connect Slack app in their workspace, +they will be redirected back to the Slack integration page in the Fylamynt web app with an authorization code. The web app will then call this API endpoint with that 'code' in the query parameter. Instead, if the user rejects to authorize the Fylamynt Slack app in their workspace, the API request from the web app will contain the @@ -5893,44 +5912,25 @@ processes the request and returns success or failure response to the web app. Slack instance alias is part of 'state' query parameter, previously 'state' query parameter contained subdomain.

-
Authorizations:
auth
query Parameters
workspace_id
string

Currently selected Workspace ID

-

Responses

Authorizations:
auth
query Parameters
code
string

Slack authorization code. Provide either code or an error message, but not both.

+
error
string

Error message. Provide either code or an error message, but not both.

+
state
required
string

Alias of the Slack integration

+
workspace_id
string

Currently selected Workspace ID

+

Responses

This API is used for fetching the Slack integration URL

'integration_id' URI parameter is not required for this API

-
Authorizations:
auth

Responses

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Get Slack Integration URL

This API is used to retrieve the Slack integration URL. +The integration_id URI parameter is optional for this API.

+
Authorizations:
auth
query Parameters
alias
string

Slack integration alias.

+

Responses

Returns a MapList for the list of trigger connectors each containing four attributes:

    -
  • name: system name of the trigger service (including the 'manual' option)
    • -
  • display_name: trigger name to show in the trigger selection menu as well as in the Editor
    • -
  • snippet_name: the snippet to load as the first anchor node in the Editor
    • -
  • is_configured: boolean for the integration status of the connector - (deprecated and now the value is set to 'True' always) -Note that all connectors map to the Unified Trigger Node (named 'Trigger'). -[ -{ - "name": "manual", - "display_name": "Manual", - "snippet_name": "Manual_Trigger", - "is_configured": True -}, -{ - "name": "aws_health", - "display_name": "AWS Health", - "snippet_name": "Trigger", - "is_configured": True -} -...... -{ - "name": "webhook", - "display_name": "Generic Webhook", - "snippet_name": "Trigger", - "is_configured": True -} -]
    • -
-
Authorizations:
auth

Responses

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

List Trigger Connectors

Endpoint to fetch the list of trigger connectors each containing the name, display name, snippet name, and +configuration status of the respective connector.

+
Authorizations:
auth

Responses

The Fylamynt web app will make a POST request to this endpoint that contains an

authorization code in the query parameter. Once we receive this request, +

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

The Fylamynt web app will make a POST request to this endpoint that contains an

authorization code in the query parameter. Once we receive this request, we will use the auth code and exchange it for an OAuth token with a request type 'authorization_code' by calling back to Zoom. If we successfully exchange the auth code for a token, we will then save @@ -5939,16 +5939,38 @@

This API is used for fetching the Zoom app integration URL

Authorizations:
auth

Responses

Get the list of instances for a given integration/resource

Authorizations:
auth
path Parameters
service
required
string

Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)

+

List Integration Instances

Get the list of instances for a given service.

+
Authorizations:
auth
path Parameters
service
required
string

Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)

query Parameters
disable_redact
string

Disable redacting API keys

workspace_id
string

Currently selected Workspace ID

-

Responses

Responses

Create a new secret for a given service

Authorizations:
auth
path Parameters
service
required
string

Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)

+

Response samples

Content type
application/json
{
  • "body": [
    ],
  • "statusCode": 0
}

Create Secret

Create a new secret for a given service.

+

The Example model contains models for all services that can be created. +When calling this endpoint for a specific service, only the credentials +for that service should be provided in the payload.

+

The payload should be structured with the credentials inside a 'credentials' key. +For example, for an S3 integration:

+

{ + "credentials": { + "alias": "my-s3-integration", + "target": "my-target", + "name": "my-bucket-name" + } +}

+

Not all fields from all_input_models need to be sent in the payload, +only those relevant to the specific service being created.

+

Response will be the instance credentials that was created.

+
Authorizations:
auth
path Parameters
service
required
string

Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)

query Parameters
workspace_id
string

Currently selected Workspace ID

-

Responses

Endpoint handling two use cases for removing connector integration or resource:

    +
Request Body schema: application/json
object (AnsibleCredentials)
object (Azure_openaiCredentials)
object (BitbucketCredentials)
object (CloudformationCredentials)
object (DatadogCredentials)
object (EksCredentials)
object (ElasticsearchCredentials)
object (GitCredentials)
object (GkeCredentials)
object (HttpCredentials)
object (HumioCredentials)
object (JenkinsCredentials)
object (JiraCredentials)
object (New_relicCredentials)
object (PagerdutyCredentials)
object (PulumiCredentials)
object (S3Credentials)
object (ServicenowCredentials)
object (SlackCredentials)
object (SplunkCredentials)
object (Splunk_on_callCredentials)
object (SpotCredentials)
object (SshCredentials)
object (SumologicCredentials)
object (TerraformCredentials)
object (Terraform_cliCredentials)
object (TwilioCredentials)
object (ZendeskCredentials)

Responses

Request samples

Content type
application/json
{
  • "ansible": {
    },
  • "azure_openai": {
    },
  • "bitbucket": {
    },
  • "cloudformation": {
    },
  • "datadog": {
    },
  • "eks": {
    },
  • "elasticsearch": {
    },
  • "git": {
    },
  • "gke": {
    },
  • "http": {
    },
  • "humio": {
    },
  • "jenkins": {
    },
  • "jira": {
    },
  • "new_relic": {
    },
  • "pagerduty": {
    },
  • "pulumi": {
    },
  • "s3": {
    },
  • "servicenow": {
    },
  • "slack": {
    },
  • "splunk": {
    },
  • "splunk_on_call": {
    },
  • "spot": {
    },
  • "ssh": {
    },
  • "sumologic": {
    },
  • "terraform": {
    },
  • "terraform_cli": {
    },
  • "twilio": {
    },
  • "zendesk": {
    }
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Delete Integration/Resource

Endpoint handling two use cases for removing connector integration or resource:

+
  1. For connectors storing secrets in the tenant secrets db, remove the dynamic secret keys added during connector integration
  2. For target account oriented resources stored in the Target Settings DB, @@ -5956,14 +5978,19 @@
Authorizations:
auth
path Parameters
integration_id
required
string
service
required
string

Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)

query Parameters
workspace_id
string

Currently selected Workspace ID

-

Responses

Responses

Get the details of an individual integration/resource instance

Authorizations:
auth
path Parameters
integration_id
required
string
service
required
string

Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)

+

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Get Integration/Resource

Get the details of the selected integration/resource instance.

+

Note: The JSON response will contain credentials specific to the selected service and integration, +unlike the response model which shows all possible fields for all services. The model is provided +to illustrate the complete set of fields that may be present in the response, depending on which +service and integration is selected.

+
Authorizations:
auth
path Parameters
integration_id
required
string
service
required
string

Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)

query Parameters
disable_redact
string

Disable redacting API keys

workspace_id
string

Currently selected Workspace ID

-

Responses

Responses

Update secret for a given service

An empty PATCH body "{}" will set the instance to default.

+

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Set Default/Move Integration/Resource

An empty PATCH body "{}" will set the instance to default.

To move an individual instance: call this endpoint with the 'old' workspace_id as the query parameter and the 'new' workspace_id in the body.

@@ -5972,21 +5999,40 @@ https:///settings//?workspace_id=cws-movefrom body: {"workspace_id": "cws-moveto"}

Authorizations:
auth
path Parameters
integration_id
required
string
service
required
string

Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)

-
query Parameters
workspace_id
string

Currently selected Workspace ID

-

Responses

Update secret for a given service and given integration instance

Authorizations:
auth
path Parameters
integration_id
required
string
service
required
string

Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)

+
Request Body schema: application/json

Workspace ID of the workspace to move integration/resource to.

+
Schema not provided

Responses

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Update Integration/Resource

Update the Integration/Resource secrets for a given service and given integration instance.

+

Note: The displayed request and response models show the structure for each service. +When calling this endpoint, only the credentials for the specific service being updated +should be provided in the payload under the 'credentials' key. The response will contain +the newly updated integration information for that service.

+

For example, to update a Slack integration:

+

Request: +{ + "credentials": { + "alias": "updated-slack-integration", + "bot_token": "xoxb-updated-token", + "signing_secret": "updated-secret" + } +}

+

Response will contain the updated Slack integration details.

+
Authorizations:
auth
path Parameters
integration_id
required
string
service
required
string

Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)

query Parameters
disable_redact
string

Disable redacting API keys

workspace_id
string

Currently selected Workspace ID

-

Responses

Request Body schema: application/json
object (AnsibleCredentials)
object (Azure_openaiCredentials)
object (BitbucketCredentials)
object (CloudformationCredentials)
object (DatadogCredentials)
object (EksCredentials)
object (ElasticsearchCredentials)
object (GitCredentials)
object (GkeCredentials)
object (HttpCredentials)
object (HumioCredentials)
object (JenkinsCredentials)
object (JiraCredentials)
object (New_relicCredentials)
object (PagerdutyCredentials)
object (PulumiCredentials)
object (S3Credentials)
object (ServicenowCredentials)
object (SlackCredentials)
object (SplunkCredentials)
object (Splunk_on_callCredentials)
object (SpotCredentials)
object (SshCredentials)
object (SumologicCredentials)
object (TerraformCredentials)
object (Terraform_cliCredentials)
object (TwilioCredentials)
object (ZendeskCredentials)

Responses

Connect Targets

Gets a list of all accounts

Authorizations:
auth
query Parameters
workspace_id
string

Currently selected Workspace ID

+

Request samples

Content type
application/json
{
  • "ansible": {
    },
  • "azure_openai": {
    },
  • "bitbucket": {
    },
  • "cloudformation": {
    },
  • "datadog": {
    },
  • "eks": {
    },
  • "elasticsearch": {
    },
  • "git": {
    },
  • "gke": {
    },
  • "http": {
    },
  • "humio": {
    },
  • "jenkins": {
    },
  • "jira": {
    },
  • "new_relic": {
    },
  • "pagerduty": {
    },
  • "pulumi": {
    },
  • "s3": {
    },
  • "servicenow": {
    },
  • "slack": {
    },
  • "splunk": {
    },
  • "splunk_on_call": {
    },
  • "spot": {
    },
  • "ssh": {
    },
  • "sumologic": {
    },
  • "terraform": {
    },
  • "terraform_cli": {
    },
  • "twilio": {
    },
  • "zendesk": {
    }
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "statusCode": 0
}

Connect Targets

Gets a list of all accounts

Authorizations:
auth
query Parameters
workspace_id
string

Currently selected Workspace ID

Responses

Creates a new entry in the database

Authorizations:
auth
query Parameters
workspace_id
string

Currently selected Workspace ID

Request Body schema: application/json
alias
required
string
external_id
required
string
is_default
required
boolean
preferred_region
required
string
role_arn
required
string

Responses

Request samples

Content type
application/json
{
  • "alias": "string",
  • "external_id": "string",
  • "is_default": true,
  • "preferred_region": "string",
  • "role_arn": "string"
}

Response samples

Content type
application/json
{
  • "alias": "string",
  • "external_id": "string",
  • "is_default": true,
  • "preferred_region": "string",
  • "role_arn": "string"
}

Only return the default entry

It's acceptable to have zero defaults, but more than one should +

Request samples

Content type
application/json
{
  • "alias": "string",
  • "external_id": "string",
  • "is_default": true,
  • "preferred_region": "string",
  • "role_arn": "string"
}

Response samples

Content type
application/json
{
  • "alias": "string",
  • "external_id": "string",
  • "is_default": true,
  • "preferred_region": "string",
  • "role_arn": "string"
}

Only return the default entry

It's acceptable to have zero defaults, but more than one should be cleaned up. This can be done by updating an existing entry to set is_default=True.

Authorizations:
auth
query Parameters
workspace_id
string

Currently selected Workspace ID

Responses

get all fields of a specific account

Authorizations:
auth
path Parameters
target_alias
required
string

Unique alias for the target account

Responses

Response samples

Content type
application/json
{
  • "alias": "string",
  • "external_id": "string",
  • "is_default": true,
  • "preferred_region": "string",
  • "role_arn": "string"
}

Update fields on an account

This will only change the updated fields and will +

Response samples

Content type
application/json
{
  • "alias": "string",
  • "external_id": "string",
  • "is_default": true,
  • "preferred_region": "string",
  • "role_arn": "string"
}

Update fields on an account

This will only change the updated fields and will leave all other fields in place.

Authorizations:
auth
path Parameters
target_alias
required
string

Unique alias for the target account

query Parameters
workspace_id
string

Currently selected Workspace ID

Request Body schema: application/json
alias
required
string
external_id
required
string
is_default
required
boolean
preferred_region
required
string
role_arn
required
string

Responses

Request samples

Content type
application/json
{
  • "alias": "string",
  • "external_id": "string",
  • "is_default": true,
  • "preferred_region": "string",
  • "role_arn": "string"
}

Response samples

Content type
application/json
{
  • "alias": "string",
  • "external_id": "string",
  • "is_default": true,
  • "preferred_region": "string",
  • "role_arn": "string"
}

Connect Workflows

Return all user workflows for a given workspace

Authorizations:
auth
query Parameters
owner
string

SSM document owner (value=Self|Amazon|All, default=All)

+

Request samples

Content type
application/json
{
  • "alias": "string",
  • "external_id": "string",
  • "is_default": true,
  • "preferred_region": "string",
  • "role_arn": "string"
}

Response samples

Content type
application/json
{
  • "alias": "string",
  • "external_id": "string",
  • "is_default": true,
  • "preferred_region": "string",
  • "role_arn": "string"
}

Connect Workflows

Return all user workflows for a given workspace

Authorizations:
auth
query Parameters
owner
string

SSM document owner (value=Self|Amazon|All, default=All)

workspace_id
string

Currently selected Workspace ID

Responses

Request samples

Content type
application/json
{
  • "Content": {
    },
  • "Name": "string",
  • "StepDocuments": [
    ],
  • "Tags": [
    ]
}

Response samples

Content type
application/json
{
  • "Content": {
    },
  • "Name": "string",
  • "StepDocuments": [
    ],
  • "Tags": [
    ],
  • "DocumentFormat": "string",
  • "DocumentType": "string",
  • "DocumentVersion": "string",
  • "Status": "string"
}

Delete Workflow

Delete a selected version of the selected workflow. +

Request samples

Content type
application/json
{
  • "Content": {
    },
  • "Name": "string",
  • "StepDocuments": [
    ],
  • "Tags": [
    ]
}

Response samples

Content type
application/json
{
  • "Content": {
    },
  • "Name": "string",
  • "StepDocuments": [
    ],
  • "Tags": [
    ],
  • "DocumentFormat": "string",
  • "DocumentType": "string",
  • "DocumentVersion": "string",
  • "Status": "string"
}

Delete Workflow

Delete a selected version of the selected workflow. If no version is specified, delete all versions of the workflow.

Authorizations:
auth
path Parameters
workflow_name
required
string

Unique workflow name

query Parameters
version
string

Selected workflow version

workspace_id
string

Currently selected Workspace ID

Responses

Response samples

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

Update Workflow

Update a selected workflow by creating a new version. +

Response samples

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

Update Workflow

Update a selected workflow by creating a new version. New workflow is created off of the latest version in SSM.

Authorizations:
auth
path Parameters
workflow_name
required
string

Unique workflow name

query Parameters
workspace_id
string

Currently selected Workspace ID

@@ -6031,17 +6077,17 @@
Tags
Array of strings

List of workflow tags.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "Description": "string",
  • "DocumentVersion": "string",
  • "Editor": "string",
  • "EditorId": "string",
  • "Name": "string",
  • "ReadOnly": true,
  • "Tags": [
    ],
  • "UpdatedDate": "string",
  • "WorkflowId": "string",
  • "WorkflowOwner": "string",
  • "WorkflowOwnerId": "string",
  • "WorkspaceId": "string",
  • "CreatedDate": "string",
  • "DefaultVersion": "string",
  • "DisplayName": "string",
  • "DocumentFormat": "string",
  • "DocumentType": "string",
  • "HashType": "string",
  • "IsDefault": true,
  • "LatestVersion": "string",
  • "Parameters": [
    ],
  • "PlatformTypes": "string",
  • "SSMDocument": "string",
  • "SchemaVersion": "string",
  • "SsmHash": "string",
  • "SsmName": "string",
  • "Status": "string",
  • "StepDocuments": [
    ],
  • "TenantId": "string",
  • "Versions": [
    ]
}

Get Workflow Name Availability

Check if workflow name is available for use.

+

Request samples

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

Response samples

Content type
application/json
{
  • "Description": "string",
  • "DocumentVersion": "string",
  • "Editor": "string",
  • "EditorId": "string",
  • "Name": "string",
  • "ReadOnly": true,
  • "Tags": [
    ],
  • "UpdatedDate": "string",
  • "WorkflowId": "string",
  • "WorkflowOwner": "string",
  • "WorkflowOwnerId": "string",
  • "WorkspaceId": "string",
  • "CreatedDate": "string",
  • "DefaultVersion": "string",
  • "DisplayName": "string",
  • "DocumentFormat": "string",
  • "DocumentType": "string",
  • "HashType": "string",
  • "IsDefault": true,
  • "LatestVersion": "string",
  • "Parameters": [
    ],
  • "PlatformTypes": "string",
  • "SSMDocument": "string",
  • "SchemaVersion": "string",
  • "SsmHash": "string",
  • "SsmName": "string",
  • "Status": "string",
  • "StepDocuments": [
    ],
  • "TenantId": "string",
  • "Versions": [
    ]
}

Get Workflow Name Availability

Check if workflow name is available for use.

Authorizations:
auth
path Parameters
workflow_name
required
string

Unique workflow name

Responses

Response samples

Content type
application/json
{
  • "available": true,
  • "message": "string",
  • "name": "string"
}

Get Workflow Content

Return the content of the default/selected version of the selected workflow.

+

Response samples

Content type
application/json
{
  • "available": true,
  • "message": "string",
  • "name": "string"
}

Get Workflow Content

Return the content of the default/selected version of the selected workflow.

Authorizations:
auth
path Parameters
workflow_name
required
string

Unique workflow name

query Parameters
version
string

Selected workflow version

workspace_id
string

Currently selected Workspace ID

Responses

Response samples

Content type
application/json
{
  • "Content": {
    },
  • "Description": "string",
  • "Name": "string",
  • "Parameters": [
    ],
  • "StepDocuments": [
    ],
  • "UpdatedDate": "string",
  • "WorkflowId": "string",
  • "showModal": true
}

Create Duplicate Workflow

Duplicate a specific version of the selected workflow.

+

Response samples

Content type
application/json
{
  • "Content": {
    },
  • "Description": "string",
  • "Name": "string",
  • "Parameters": [
    ],
  • "StepDocuments": [
    ],
  • "UpdatedDate": "string",
  • "WorkflowId": "string",
  • "showModal": true
}

Create Duplicate Workflow

Duplicate a specific version of the selected workflow.

Authorizations:
auth
path Parameters
workflow_name
required
string

Unique workflow name

query Parameters
name
string

Name of workflow to be duplicated

workspace_id
string

Currently selected Workspace ID

@@ -6050,31 +6096,31 @@

Responses

Request samples

Content type
application/json
{
  • "NewName": "string",
  • "Version": "string"
}

Response samples

Content type
application/json
{
  • "Description": "string",
  • "DocumentVersion": "string",
  • "Editor": "string",
  • "EditorId": "string",
  • "Name": "string",
  • "ReadOnly": true,
  • "Tags": [
    ],
  • "UpdatedDate": "string",
  • "WorkflowId": "string",
  • "WorkflowOwner": "string",
  • "WorkflowOwnerId": "string",
  • "WorkspaceId": "string",
  • "CreatedDate": "string",
  • "DefaultVersion": "string",
  • "DisplayName": "string",
  • "DocumentFormat": "string",
  • "DocumentType": "string",
  • "HashType": "string",
  • "IsDefault": true,
  • "LatestVersion": "string",
  • "Parameters": [
    ],
  • "PlatformTypes": "string",
  • "SSMDocument": "string",
  • "SchemaVersion": "string",
  • "SsmHash": "string",
  • "SsmName": "string",
  • "Status": "string",
  • "StepDocuments": [
    ],
  • "TenantId": "string",
  • "Versions": [
    ]
}

Get Workflow Information

Return the information for the default/selected version of the selected workflow, +

Request samples

Content type
application/json
{
  • "NewName": "string",
  • "Version": "string"
}

Response samples

Content type
application/json
{
  • "Description": "string",
  • "DocumentVersion": "string",
  • "Editor": "string",
  • "EditorId": "string",
  • "Name": "string",
  • "ReadOnly": true,
  • "Tags": [
    ],
  • "UpdatedDate": "string",
  • "WorkflowId": "string",
  • "WorkflowOwner": "string",
  • "WorkflowOwnerId": "string",
  • "WorkspaceId": "string",
  • "CreatedDate": "string",
  • "DefaultVersion": "string",
  • "DisplayName": "string",
  • "DocumentFormat": "string",
  • "DocumentType": "string",
  • "HashType": "string",
  • "IsDefault": true,
  • "LatestVersion": "string",
  • "Parameters": [
    ],
  • "PlatformTypes": "string",
  • "SSMDocument": "string",
  • "SchemaVersion": "string",
  • "SsmHash": "string",
  • "SsmName": "string",
  • "Status": "string",
  • "StepDocuments": [
    ],
  • "TenantId": "string",
  • "Versions": [
    ]
}

Get Workflow Information

Return the information for the default/selected version of the selected workflow, including workflow description and tags.

Authorizations:
auth
path Parameters
workflow_name
required
string

Unique workflow name

query Parameters
version
string

Selected workflow version

workspace_id
string

Currently selected Workspace ID

Responses

Response samples

Content type
application/json
{
  • "Description": "string",
  • "DocumentVersion": "string",
  • "Editor": "string",
  • "EditorId": "string",
  • "Name": "string",
  • "ReadOnly": true,
  • "Tags": [
    ],
  • "UpdatedDate": "string",
  • "WorkflowId": "string",
  • "WorkflowOwner": "string",
  • "WorkflowOwnerId": "string",
  • "WorkspaceId": "string",
  • "CreatedDate": "string",
  • "DefaultVersion": "string",
  • "DisplayName": "string",
  • "DocumentFormat": "string",
  • "DocumentType": "string",
  • "HashType": "string",
  • "IsDefault": true,
  • "LatestVersion": "string",
  • "Parameters": [
    ],
  • "PlatformTypes": "string",
  • "SSMDocument": "string",
  • "SchemaVersion": "string",
  • "SsmHash": "string",
  • "SsmName": "string",
  • "Status": "string",
  • "StepDocuments": [
    ],
  • "TenantId": "string",
  • "Versions": [
    ],
  • "Schedules": { }
}

Update Workflow Version

Update the default version of the workflow to a specific version.

+

Response samples

Content type
application/json
{
  • "Description": "string",
  • "DocumentVersion": "string",
  • "Editor": "string",
  • "EditorId": "string",
  • "Name": "string",
  • "ReadOnly": true,
  • "Tags": [
    ],
  • "UpdatedDate": "string",
  • "WorkflowId": "string",
  • "WorkflowOwner": "string",
  • "WorkflowOwnerId": "string",
  • "WorkspaceId": "string",
  • "CreatedDate": "string",
  • "DefaultVersion": "string",
  • "DisplayName": "string",
  • "DocumentFormat": "string",
  • "DocumentType": "string",
  • "HashType": "string",
  • "IsDefault": true,
  • "LatestVersion": "string",
  • "Parameters": [
    ],
  • "PlatformTypes": "string",
  • "SSMDocument": "string",
  • "SchemaVersion": "string",
  • "SsmHash": "string",
  • "SsmName": "string",
  • "Status": "string",
  • "StepDocuments": [
    ],
  • "TenantId": "string",
  • "Versions": [
    ],
  • "Schedules": { }
}

Update Workflow Version

Update the default version of the workflow to a specific version.

Authorizations:
auth
path Parameters
workflow_name
required
string

Unique workflow name

query Parameters
version
string

Selected workflow version

workspace_id
string

Currently selected Workspace ID

Responses

Response samples

Content type
application/json
{
  • "Description": "string",
  • "DocumentVersion": "string",
  • "Editor": "string",
  • "EditorId": "string",
  • "Name": "string",
  • "ReadOnly": true,
  • "Tags": [
    ],
  • "UpdatedDate": "string",
  • "WorkflowId": "string",
  • "WorkflowOwner": "string",
  • "WorkflowOwnerId": "string",
  • "WorkspaceId": "string",
  • "CreatedDate": "string",
  • "DefaultVersion": "string",
  • "DisplayName": "string",
  • "DocumentFormat": "string",
  • "DocumentType": "string",
  • "HashType": "string",
  • "IsDefault": true,
  • "LatestVersion": "string",
  • "Parameters": [
    ],
  • "PlatformTypes": "string",
  • "SSMDocument": "string",
  • "SchemaVersion": "string",
  • "SsmHash": "string",
  • "SsmName": "string",
  • "Status": "string",
  • "StepDocuments": [
    ],
  • "TenantId": "string",
  • "Versions": [
    ],
  • "Schedules": { }
}

List Workflow Integrations

Return a list of integration instances for the default/selected version of a selected workflow.

+

Response samples

Content type
application/json
{
  • "Description": "string",
  • "DocumentVersion": "string",
  • "Editor": "string",
  • "EditorId": "string",
  • "Name": "string",
  • "ReadOnly": true,
  • "Tags": [
    ],
  • "UpdatedDate": "string",
  • "WorkflowId": "string",
  • "WorkflowOwner": "string",
  • "WorkflowOwnerId": "string",
  • "WorkspaceId": "string",
  • "CreatedDate": "string",
  • "DefaultVersion": "string",
  • "DisplayName": "string",
  • "DocumentFormat": "string",
  • "DocumentType": "string",
  • "HashType": "string",
  • "IsDefault": true,
  • "LatestVersion": "string",
  • "Parameters": [
    ],
  • "PlatformTypes": "string",
  • "SSMDocument": "string",
  • "SchemaVersion": "string",
  • "SsmHash": "string",
  • "SsmName": "string",
  • "Status": "string",
  • "StepDocuments": [
    ],
  • "TenantId": "string",
  • "Versions": [
    ],
  • "Schedules": { }
}

List Workflow Integrations

Return a list of integration instances for the default/selected version of a selected workflow.

Authorizations:
auth
path Parameters
workflow_name
required
string

Unique workflow name

query Parameters
movable_only
string

Only include integrations that can be moved to new workspace

version
string

Selected workflow version

workspace_id
string

Currently selected Workspace ID

Responses

Response samples

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

Connect Workspaces

List Workspaces

List all workspaces the user is authorized to view.

+

Response samples

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

Connect Workspaces

List Workspaces

List all workspaces the user is authorized to view.

Authorizations:
auth
header Parameters
X-Fields
string <mask>

An optional fields mask

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "workspace_id": "string",
  • "permissions": [
    ]
}

Create Workspace

Create a new workspace.

+

Response samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "workspace_id": "string",
  • "permissions": [
    ]
}

Create Workspace

Create a new workspace.

Authorizations:
auth
header Parameters
X-Fields
string <mask>

An optional fields mask

Request Body schema: application/json
description
string

Description of workspace

Array of objects (EntityBlock)

List of entities

@@ -6084,17 +6130,17 @@

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "entities": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "workspace_id": "string",
  • "permissions": [
    ]
}

Workspace Availability

Check if Workspace name is available for use.

+

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "entities": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "workspace_id": "string",
  • "permissions": [
    ]
}

Check Workspace Availability

Check if Workspace name is available for use.

Authorizations:
auth
header Parameters
X-Fields
string <mask>

An optional fields mask

Request Body schema: application/json
name
required
string

Workspace name to check

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "name": "string",
  • "available": true,
  • "message": "string"
}

Get Workspace by Name

Get details of a specific workspace using workspace name.

+

Request samples

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

Response samples

Content type
application/json
{
  • "name": "string",
  • "available": true,
  • "message": "string"
}

Get Workspace by Name

Get details of a specific workspace using workspace name.

Authorizations:
auth
path Parameters
workspace_name
required
string

Workspace name

header Parameters
X-Fields
string <mask>

An optional fields mask

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "workspace_id": "string"
}

Delete Workspace

Delete a workspace specified by workspace_id

+

Response samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "workspace_id": "string"
}

Delete Workspace

Delete a workspace specified by workspace_id

Authorizations:
auth
path Parameters
workspace_id
required
string

Unique workspace ID

Responses

header Parameters
X-Fields
string <mask>

An optional fields mask

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "workspace_id": "string",
  • "permissions": [
    ]
}

Update Workspace

Update a workspace specified by workspace_id.

+

Response samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "workspace_id": "string",
  • "permissions": [
    ]
}

Update Workspace

Update a workspace specified by workspace_id.

Authorizations:
auth
path Parameters
workspace_id
required
string

Unique workspace ID

header Parameters
X-Fields
string <mask>

An optional fields mask

Request Body schema: application/json
description
string

Description of workspace

@@ -6113,7 +6159,7 @@
type
string

Type of workspace

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "entities": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "workspace_id": "string",
  • "permissions": [
    ]
}

Move Workflow and its Integrations to Another Workpace

It moves a workflow and all integrations it uses +

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "entities": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "owner": "string",
  • "type": "string",
  • "workspace_id": "string",
  • "permissions": [
    ]
}

Move Workflow and its Integrations to Another Workpace

It moves a workflow and all integrations it uses in new workspace. Following things are needed - Permissions the user needs in both workspaces: updateWorkflow @@ -6126,9 +6172,9 @@

workspace_id
string

Workspace ID to move the workflow into

Responses

Request samples

Content type
application/json
{
  • "move_all_integrations": true,
  • "workflow_name": "string",
  • "workspace_id": "string"
}
+

Request samples

Content type
application/json
{
  • "move_all_integrations": true,
  • "workflow_name": "string",
  • "workspace_id": "string"
}