Skip to main content
POST
/
api
/
consumers
Create consumer
curl --request POST \
  --url https://app.vaultgraph.com/api/consumers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "linked_consumer_org_id": "<string>",
    "linked_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Request payload for creating a new consumer.

​
name
string
required

Human-readable name of the consumer.

​
description
string | null

Optional description of the consumer.

Response

Consumer created

​
data
object

Representation of a consumer in the VaultGraph portal.