validates aws cloud watch credentials

POST 
https://api.spectrocloud.com/v1/clouds/aws/cloudwatch/validate

Validates aws cloud watch credentials

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

required

Request payload for cloud watch config

credentials

object

AWS cloud account which includes access key and secret key in case of 'secret' credentials type. It includes policyARNS, ARN and externalId in case of sts. Partition is a group of AWS Region and Service objects

accessKeystring

AWS account access key

credentialTypestring

Possible values: [secret, sts]

Default value: secret

Allowed Values [secret, sts]. STS type will be used for role assumption for sts type, accessKey/secretKey contains the source account, Arn is the target account.

partitionstring

Possible values: [aws, aws-us-gov]

Default value: aws

AWS accounts are scoped to a single partition. Allowed values [aws, aws-us-gov], Default values

policyARNsstring[]

List of policy ARNs required in case of credentialType sts.

secretKeystring

AWS account secret key

sts

object

AWS STS credentials in case of credentialType sts, will be empty in case of credential type secret

arnstring

Arn for the aws sts credentials in cloud account

externalIdstring

ExternalId for the aws sts credentials in cloud account

groupstring

Name of the group

regionstring

Name of the region

streamstring

Name of the stream

Responses

204

Ok response without content

Response Headers

• AuditUid

  string

  Audit uid for the request

• curl
• python
• go
• nodejs
• java

• CURL

curl -L 'https://api.spectrocloud.com/v1/clouds/aws/cloudwatch/validate' \
-H 'Content-Type: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
-d '{
  "credentials": {
    "accessKey": "string",
    "credentialType": "secret",
    "partition": "aws",
    "policyARNs": [
      "string"
    ],
    "secretKey": "string",
    "sts": {
      "arn": "string",
      "externalId": "string"
    }
  },
  "group": "string",
  "region": "string",
  "stream": "string"
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

ProjectUid — header

Body required

{
  "credentials": {
    "accessKey": "string",
    "credentialType": "secret",
    "partition": "aws",
    "policyARNs": [
      "string"
    ],
    "secretKey": "string",
    "sts": {
      "arn": "string",
      "externalId": "string"
    }
  },
  "group": "string",
  "region": "string",
  "stream": "string"
}