Skip to main content
POST
/
api
/
v1
/
instances
Create Instance
curl --request POST \
  --url https://api.checkpoint.b-digital.uk/api/v1/instances \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "status": "upcoming",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "location": "<string>"
}
'
{
  "success": true,
  "data": {},
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Body

application/json
name
string
required
description
string
status
enum<string>
default:upcoming
Available options:
upcoming,
active,
completed,
archived
start_date
string<date>
end_date
string<date>
location
string

Response

201 - application/json

Instance created successfully

success
boolean
Example:

true

data
object
meta
object