Skip to main content
GET
/
workflows
/
{workflow_id}
/
metadata
Get workflow metadata
curl --request GET \
  --url https://api.cloudcruise.com/workflows/{workflow_id}/metadata
{
  "input_schema": {
    "type": "object",
    "properties": {
      "STATE": [
        "string"
      ],
      "SEARCH_TERM": [
        "string"
      ],
      "USER": "<string>"
    },
    "required": "SEARCH_TERM"
  },
  "vault_schema": {
    "USER": {
      "type": "credential",
      "domain": "https://example.com",
      "example": "11223344-5566-7788-9900-112233445566"
    }
  }
}

Headers

​
cc-key
string

CloudCruise API key for authentication

Path Parameters

​
workflow_id
string
required

The ID of the workflow

Response

Successful operation

​
input_schema
object
​
vault_schema
object

Schema defining vault credentials and their configuration

Example:
{
  "USER": {
    "type": "credential",
    "domain": "https://example.com",
    "example": "11223344-5566-7788-9900-112233445566"
  }
}