create data sink config

POST 
https://api.spectrocloud.com/v1/tenants/:tenantUid/assets/dataSinks

create data sink config

Request

Path Parameters

tenantUid stringrequired

application/json

Body

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name of the resource

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

Populated by the system. Read-only.

spec

object

auditDataSinks

object[]

Array [

cloudWatch

object

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

regionstring

streamstring

typestring

Possible values: [cloudwatch]

]

Responses

201

Created successfully

Response Headers

• AuditUid

  string

  Audit uid for the request

application/json

Schema

Schema

uidstringrequired

Example (from schema)

{
  "uid": "string"
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X POST 'https://api.spectrocloud.com/v1/tenants/:tenantUid/assets/dataSinks' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
--data-raw '{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-02T20:23:32.996Z",
    "deletionTimestamp": "2024-07-02T20:23:32.996Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-02T20:23:32.996Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "auditDataSinks": [
      {
        "cloudWatch": {
          "credentials": {
            "accessKey": "string",
            "credentialType": "secret",
            "partition": "aws",
            "policyARNs": [
              "string"
            ],
            "secretKey": "string",
            "sts": {
              "arn": "string",
              "externalId": "string"
            }
          },
          "group": "string",
          "region": "string",
          "stream": "string"
        },
        "type": "cloudwatch"
      }
    ]
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

tenantUid — pathrequired

Body

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-02T20:23:32.996Z",
    "deletionTimestamp": "2024-07-02T20:23:32.996Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-02T20:23:32.996Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "auditDataSinks": [
      {
        "cloudWatch": {
          "credentials": {
            "accessKey": "string",
            "credentialType": "secret",
            "partition": "aws",
            "policyARNs": [
              "string"
            ],
            "secretKey": "string",
            "sts": {
              "arn": "string",
              "externalId": "string"
            }
          },
          "group": "string",
          "region": "string",
          "stream": "string"
        },
        "type": "cloudwatch"
      }
    ]
  }
}