Delete custom metadata columns

Delete custom metadata columns from the Asset catalog for all tasks in the environment.

DELETE https://{controlplane_path}/api/1/rest/public/catalog/{env_org}/custom-metadata/columns

Delete custom metadata columns from the Asset catalog for all tasks in the environment.

Prerequisites

Environment (Org) admin permissions

Path parameters


Key	Description
`controlplane_path`	Required. The path to the SnapLogic control plane: `elastic.snaplogic.com` For the UAT or EMEA control plane, substitute the name for `elastic`. For example: `uat.elastic.snaplogic.com` `emea.snaplogic.com`
`env_org`	Required. The name of the SnapLogic environment/Org. For example, `My-Dev-Env`

Query parameters

None.

Request header

Basic authentication

To use basic authentication, specify Basic for authorization in the request header, add your credentials (email and password for your SnapLogic user or service account), and specify application/json for content type. For example:


Authorization: Basic {base64_encoded <email>:<password>}
Content-Type: application/json

Example of basic authentication using Postman:

Learn more about the basic authentication header in REST API requests.

JWT authentication

When using JWT authentication, the API request includes specific headers. In the request header, specify Bearer Token for authorization, add the token, and specify application/json for content type. These headers are automatically added when you configure bearer token authentication in your API client. The authorization header contains the word Bearer followed by a space and your JWT.


Authorization: Bearer Token {token}
Content-Type: application/json

Example of JWT authentication using Postman:

Request body

A list of strings that specify the names of the custom columns to delete:

[
  "customColumn1",
  "customColumn2",
  "customColumn3"
]


Key	Type	Description
`customColumn`	`string`	The name of a custom column.

Response

Code 200 OK indicates that the columns were deleted.

Example

To use the following curl request to delete a custom column for all tasks in the environment:

Replace My-Dev-Env with your environment name.
Replace my_custom_col with your custom column name.

curl -X 'DELETE' \
  'http://elastic.snaplogic.com/api/1/rest/public/catalog/My-Dev-Env/custom-metadata/columns' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -d '[
  "my_custom_col"
]'