Attributes

Soda Cloud API Attribute Endpoints

List attributes

get

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/attributes

This endpoint enables you to list the attributes available in your organization's Soda Cloud account.

Optionally filter by resource type using the resourceType query parameter.

This GET is a paginated API that uses the following parameters to request specific details:

• size: Supply an integer value between 10 and 1000, inclusive. The default value is 1000.

• page: Supply an integer value. The default value is 0.

• resourceType: Optional. Filter by resource type (dataset or check).

Authentication

User authentication required: true

This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.

Authorization

Any Soda Cloud user in your organization may execute this query.

Tags

Attributes

Rate limiting

60 requests/60 seconds

Authorizations

basicAuthApiKeycookieToken

AuthorizationstringRequired

Query parameters

pageinteger · int32Optional

resourceTypeobject · enumOptionalPossible values:

sizeinteger · int32Optional

Responses

200

Successful response

application/json

firstbooleanRequired

lastbooleanRequired

numberinteger · int32Required

sizeinteger · int32Required

totalElementsinteger · int32Required

totalPagesinteger · int32Required

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/api/v1/attributes

HTTPcURLJavaScriptPython

GET /api/v1/attributes HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "content": [
    {
      "allowedValues": [
        "text"
      ],
      "description": "text",
      "id": "text",
      "label": "text",
      "name": "text",
      "resourceType": "dataset",
      "type": "text"
    }
  ],
  "first": true,
  "last": true,
  "number": 1,
  "size": 1,
  "totalElements": 1,
  "totalPages": 1
}

Create an attribute

post

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/attributes

This endpoint enables you to create a new attribute in your organization's Soda Cloud account.

Attributes are scoped to a resource type (dataset or check). Once an attribute is created, it can be set on the associated resource type. Attributes can be used to configure notification rules, dashboards, filters, etc. For example sending email alerts when checks marked as critical fail.

Authentication

User authentication required: true

This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.

Authorization

Users must have global role permission MANAGE_ATTRIBUTES to execute this call.

Tags

Attributes

Rate limiting

100 requests/60 seconds

Authorizations

basicAuthApiKeycookieToken

AuthorizationstringRequired

Body

application/json

allowedValuesstring[]Optional

descriptionstringOptional

labelstringRequired

namestringRequired

resourceTypeobject · enumRequiredPossible values:

typeobject · enumRequiredPossible values:

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post

/api/v1/attributes

HTTPcURLJavaScriptPython

POST /api/v1/attributes HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "allowedValues": [
    "text"
  ],
  "description": "text",
  "label": "text",
  "name": "text",
  "resourceType": "dataset",
  "type": "text"
}

{
  "attribute": {
    "allowedValues": [
      "text"
    ],
    "description": "text",
    "id": "text",
    "label": "text",
    "name": "text",
    "resourceType": "dataset",
    "type": "text"
  }
}

Update an attribute

post

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/attributes/{attributeId}

This endpoint enables you to update an existing attribute in your organization's Soda Cloud account.

Only label, description, and allowedValues (for select types) can be updated.

When updating allowedValues, existing attribute values on resources are left in place, even if they are no longer in the allowed set.

Authentication

User authentication required: true

This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.

Authorization

Users must have global role permission MANAGE_ATTRIBUTES to execute this call.

Tags

Attributes

Rate limiting

100 requests/60 seconds

Authorizations

basicAuthApiKeycookieToken

AuthorizationstringRequired

Path parameters

attributeIdstringRequired

Body

application/json

allowedValuesstring[]Optional

descriptionstringOptional

labelstringOptional

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post

/api/v1/attributes/{attributeId}

HTTPcURLJavaScriptPython

POST /api/v1/attributes/{attributeId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "allowedValues": [
    "text"
  ],
  "description": "text",
  "label": "text"
}

{
  "attribute": {
    "allowedValues": [
      "text"
    ],
    "description": "text",
    "id": "text",
    "label": "text",
    "name": "text",
    "resourceType": "dataset",
    "type": "text"
  }
}

Delete an attribute

delete

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/attributes/{attributeId}

This endpoint enables you to delete an existing attribute from your organization's Soda Cloud account.

The attribute will be removed from any resources where it is set.

Authentication

User authentication required: true

This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.

Authorization

Users must have global role permission MANAGE_ATTRIBUTES to execute this call.

Tags

Attributes

Rate limiting

100 requests/60 seconds

Authorizations

basicAuthApiKeycookieToken

AuthorizationstringRequired

Path parameters

attributeIdstringRequired

Responses

200

Successful response

application/json

messagestringRequired

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

delete

/api/v1/attributes/{attributeId}

HTTPcURLJavaScriptPython

DELETE /api/v1/attributes/{attributeId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "message": "text"
}