POST
/
apps
curl --request POST \
  --url https://api.us.vartiq.com/apps \
  --header 'Content-Type: application/json' \
  --header 'companyid: <companyid>' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "environment": "<string>",
  "projectId": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "environment": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Headers

companyid
string
required

The unique identifier of your company

Body Parameters

name
string
required

Name of the app

description
string

Optional description of the app

environment
string
required

Environment for the app. Must be either “development” or “production”

projectId
string
required

The unique identifier of the project this app belongs to

Response

success
boolean

Indicates if the request was successful

message
string

A message describing the result of the operation

data
object

The created app object

Response Example

{
  "success": true,
  "message": "App created successfully",
  "data": {
    "id": "app_01JT3854RQEQC8BXN79H2B1YSV",
    "name": "second app",
    "description": "",
    "environment": "development",
    "createdAt": "2025-04-30T11:43:46.469Z",
    "updatedAt": "2025-04-30T11:43:46.469Z"
  }
}
POST
/
apps
curl --request POST \
  --url https://api.us.vartiq.com/apps \
  --header 'Content-Type: application/json' \
  --header 'companyid: <companyid>' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "environment": "<string>",
  "projectId": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "environment": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Headers

companyid
string
required

The unique identifier of your company

Body Parameters

name
string
required

Name of the app

description
string

Optional description of the app

environment
string
required

Environment for the app. Must be either “development” or “production”

projectId
string
required

The unique identifier of the project this app belongs to

Response

success
boolean

Indicates if the request was successful

message
string

A message describing the result of the operation

data
object

The created app object

Response Example

{
  "success": true,
  "message": "App created successfully",
  "data": {
    "id": "app_01JT3854RQEQC8BXN79H2B1YSV",
    "name": "second app",
    "description": "",
    "environment": "development",
    "createdAt": "2025-04-30T11:43:46.469Z",
    "updatedAt": "2025-04-30T11:43:46.469Z"
  }
}