Create custom metadata columns

Create custom metadata columns in the Asset catalog for all tasks in the environment. The new columns contain no values.

POST https://{controlplane_path}/api/2/{env_id}/public/catalog/custom-metadata/columns
Create custom metadata columns in the Asset catalog for all tasks in the environment. The new columns contain no values.

Prerequisites

  • Environment (Org) admin permissions

Path parameters

Parameter Description Required
env_id The environment ID, which is available from the Environment details field in Admin Manager. Yes

Request body

A list that specifies the custom columns to create:

[
  "customColumn1",
  "customColumn2",
  "customColumn3"
]
Key Type Description
customColumn string The name of a custom column.
Important: If the request contains duplicate column names, the API uses the last and ignores the rest.

Response

Code 200 OK indicates that the columns were created.

Example

To use the following curl request to create a new column for all tasks in the environment:

  • Replace 555d444c777d99e22e9b9e99 with your environment ID.
  • Replace my_custom_col with your custom column name.
curl -X 'POST' \
  'http://elastic.snaplogic.com/api/2/555d444c777d99e22e9b9e99/public/catalog/custom-metadata/columns' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -d '[
  "my_custom_col"
]'