diff --git a/index.html b/index.html index 0c04fe00e..72b284c3a 100644 --- a/index.html +++ b/index.html @@ -3849,29 +3849,29 @@

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

Create Ocean CD Verification Provider

Create Ocean CD Verification Provider. Only one provider type can be defined

Authorizations:
auth
Request Body schema: application/json
required
object (oceanCDVerificationProvider)
object (Ocean CD Verification Provider CloudWatch)
clusterIds
required
Array of strings

List of cluster IDs that this Verification Provider will be applied to

-
object (Ocean CD Verification Provider Datadog)
name
required
string

Identifier name for Ocean CD Verification Provider. Must be unique

+
object (Ocean CD Verification Provider Datadog)
object (Ocean CD Verification Provider Jenkins)
name
required
string

Identifier name for Ocean CD Verification Provider. Must be unique

object (Ocean CD Verification Provider NewRelic)
object (Ocean CD Verification Provider Prometheus)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

List Ocean CD Verification Providers

List all Ocean CD Verification Providers.

+

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

List Ocean CD Verification Providers

List all Ocean CD Verification Providers.

Authorizations:
auth

Responses

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

Get Ocean CD Verification Provider

Get an existing Ocean CD Verification Provider.

+

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

Get Ocean CD Verification Provider

Get an existing Ocean CD Verification Provider.

Authorizations:
auth
path Parameters
name
required
string
Example: datadog-prod

The identifier of the Ocean CD Verification Provider

Responses

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

Update Ocean CD Verification Provider

Full Update of Ocean CD Verification Provider configuration. +

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

Update Ocean CD Verification Provider

Full Update of Ocean CD Verification Provider configuration. All non included fields will be nullified

Authorizations:
auth
path Parameters
name
required
string
Example: datadog-prod

The identifier name of the Ocean CD Verification Provider

Request Body schema: application/json
required
object (oceanCDVerificationProviderUpdate)
object (Ocean CD Verification Provider CloudWatch)
clusterIds
required
Array of strings

List of cluster ids that this Verification Provider will be applied to

-
object (Ocean CD Verification Provider Datadog)
object (Ocean CD Verification Provider NewRelic)
object (Ocean CD Verification Provider Prometheus)

Responses

object (Ocean CD Verification Provider Datadog)
object (Ocean CD Verification Provider Jenkins)
object (Ocean CD Verification Provider NewRelic)
object (Ocean CD Verification Provider Prometheus)

Responses

Request samples

Content type
application/json
{}

Patch Ocean CD Verification Provider

Partial update Ocean CD Verification Provider configuration.

+

Request samples

Content type
application/json
{}

Patch Ocean CD Verification Provider

Partial update Ocean CD Verification Provider configuration.

Authorizations:
auth
path Parameters
name
required
string
Example: datadog-prod

The identifier name of the Ocean CD Verification Provider

Request Body schema: application/json
required
object (Ocean CD Verification Provider)

Ocean CD Verification Provider spec entity.

object (Ocean CD Verification Provider CloudWatch)
clusterIds
Array of strings

List of cluster ids that this Verification Provider will be applied to

-
object (Ocean CD Verification Provider Datadog)
object (Ocean CD Verification Provider NewRelic)
object (Ocean CD Verification Provider Prometheus)

Responses

object (Ocean CD Verification Provider Datadog)
object (Ocean CD Verification Provider Jenkins)
object (Ocean CD Verification Provider NewRelic)
object (Ocean CD Verification Provider Prometheus)

Responses

Request samples

Content type
application/json
{}

Delete Ocean CD Verification Provider

Delete an existing Ocean CD Verification Provider.

+

Request samples

Content type
application/json
{}

Delete Ocean CD Verification Provider

Delete an existing Ocean CD Verification Provider.

Authorizations:
auth
path Parameters
name
required
string
Example: datadog-prod

The identifier name of the Ocean CD Verification Provider

Responses

name
required
string

Identifier name for Ocean CD Verification Template. Must be a unique name

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

List Ocean CD Verification Templates

List all Ocean CD Verification Templates.

+

Request samples

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

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

List Ocean CD Verification Templates

List all Ocean CD Verification Templates.

Authorizations:
auth

Responses

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

Get Ocean CD Verification Template

Get an existing Ocean CD Verification Template.

+

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

Get Ocean CD Verification Template

Get an existing Ocean CD Verification Template.

Authorizations:
auth
path Parameters
name
required
string
Example: latency-validation

The identifier of the Ocean CD Verification Template

Responses

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

Update Ocean CD Verification Template

Full update of Ocean CD Verification Template configuration. +

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

Update Ocean CD Verification Template

Full update of Ocean CD Verification Template configuration. All non included fields will be nullified

Authorizations:
auth
path Parameters
name
required
string
Example: latency-validation

The identifier name of the Ocean CD Verification Template

Request Body schema: application/json
required
object (oceanCDVerificationTemplateUpdate)
Array of objects (Ocean CD Verification Template argument)

List of verification arguments

required
Array of objects (Ocean CD Verification Metric)

List of verification metrics

Responses

Request samples

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

Patch Ocean CD Verification Template

Partial update Ocean CD Verification Template configuration.

+

Request samples

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

Patch Ocean CD Verification Template

Partial update Ocean CD Verification Template configuration.

Authorizations:
auth
path Parameters
name
required
string
Example: latency-validation

The identifier name of the Ocean CD Verification Template

Request Body schema: application/json
required
object (Ocean CD Verification Template)

Ocean CD Verification Template spec entity.

Array of objects (Ocean CD Verification Template argument)

List of verification arguments

required
Array of objects (Ocean CD Verification Metric)

List of verification metrics

Responses

Request samples

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

Delete Ocean CD Verification Template

Delete an existing Ocean CD Verification Template.

+

Request samples

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

Delete Ocean CD Verification Template

Delete an existing Ocean CD Verification Template.

Authorizations:
auth
path Parameters
name
required
string
Example: latency-validation

The identifier name of the Ocean CD Verification Template

Responses

Authorizations:
auth
path Parameters
rolloutId
required
string
Example: rol-123456

The identifier name of the Ocean CD rollout

Responses

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

Get Ocean CD Rollout Resource

Get Ocean CD rollout resource.

+

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}

Get Ocean CD Rollout Resource

Get Ocean CD rollout resource.

Authorizations:
auth
path Parameters
rolloutId
required
string
Example: rol-123456

The identifier name of the Ocean CD rollout

Responses

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.

@@ -5735,7 +5735,7 @@

Response samples

Content type
application/json
{
  • "request": {
    },
  • "response": {
    }
}