Skip to main content
POST
/
projects
/
{project_reference}
/
branches
/
{branchId}
/
status-checks
Upsert Branch Status Check
curl --request POST \
  --url https://api.veryfront.com/projects/{project_reference}/branches/{branchId}/status-checks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "check_name": "<string>",
  "status": "pending",
  "description": "<string>",
  "external_url": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "check_name": "<string>",
  "status": "pending",
  "description": "<string>",
  "external_url": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Path Parameters

project_reference
string
required

Project ID or slug

branchId
string<uuid>
required

Branch ID (UUID)

Body

application/json
check_name
string
required
status
enum<string>
required
Available options:
pending,
success,
failure
description
string
external_url
string

Response

Status check updated

id
string<uuid>
required
branch_id
string<uuid>
required
check_name
string
required
status
enum<string>
required
Available options:
pending,
success,
failure
description
string | null
required
external_url
string | null
required
created_at
string
required
updated_at
string
required