Skip to main content
POST
/
v1
/
resources
Create or update a resource
curl --request POST \
  --url https://api.ctrlplane.dev/api/v1/resources \
  --header 'Content-Type: application/json' \
  --data '{
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "kind": "<string>",
  "identifier": "<string>",
  "version": "<string>",
  "config": {},
  "metadata": {},
  "variables": [
    {
      "key": "<string>",
      "value": "<string>",
      "sensitive": true
    }
  ]
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "version": "<string>",
  "kind": "<string>",
  "identifier": "<string>",
  "config": {},
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Body

application/json
workspaceId
string<uuid>
required
name
string
required
kind
string
required
identifier
string
required
version
string
required
config
object
required
metadata
object
variables
object[]
  • Option 1
  • Option 2

Response

200 - application/json

The created or updated resource

id
string<uuid>
required
name
string
required
version
string
required
kind
string
required
identifier
string
required
config
object
required
metadata
object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
deletedAt
string<date-time> | null
required
workspaceId
string<uuid>
required
providerId
string<uuid>