Check team slug availability

GET

/api/v1/team/check-slug

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

Reports whether a slug is free for this team right now, with up to three suggestions when it is not. Advisory only: the save re-checks under a row lock, so a slug reported available can still be taken by the time it is saved. The team’s own current slug is always available to itself.

Authorizations

• BearerAuth

Parameters

Query Parameters

slug

required

string

Slug to check

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

available

boolean

code

Code is the machine-readable reason: a pkg/slug shape code, “reserved”, or “taken”.

string

reason

string

suggestions

Suggestions are free alternatives, present only when the candidate is not.

Array<string>

Example ^generated

{
  "data": {
    "available": true,
    "code": "example",
    "reason": "example",
    "suggestions": [
      "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"
  }
}

403

Forbidden

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"
  }
}