Check preview slug availability

GET

/api/v1/projects/check-preview-slug

curl --request GET \
  --url 'https://api.deploybase.eu/api/v1/api/v1/projects/check-preview-slug?preview_slug=example' \
  --header 'Authorization: <Authorization>'

Checks if a preview slug is available as the label of a project’s preview hostnames ({branch}-{preview_slug}.previews.deploybase.eu). Uniqueness is global across all teams, because the previews zone is shared.

Authorizations

• BearerAuth

Parameters

Query Parameters

preview_slug

required

string

Preview slug to check

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "data": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

400

Bad Request

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

401

Unauthorized

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

500

Internal Server Error

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}