Client

Manage Team API clients.

Get a list of API clients.

get

Requires View API Client or View All API Clients permission.

Authorizations

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

HTTPcURLJavaScriptPython

GET /api/clients HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    {
      "id": "text",
      "name": "text",
      "owner_id": "text",
      "is_disabled": true,
      "created_at": "2025-05-12T16:42:04.863Z",
      "token_generated_at": "2025-05-12T16:42:04.863Z",
      "use_custom_permissions": true,
      "allowed_permissions": {
        "teamPermissions": 1,
        "apiPermissions": 1,
        "logPermissions": 1,
        "projectPermissions": 1,
        "serverPermissions": 1,
        "websitePermissions": 1,
        "consolePermissions": 1,
        "dockerPermissions": 1,
        "dockerContainerPermissions": 1
      },
      "custom_permissions": {
        "teamPermissions": 1,
        "apiPermissions": 1,
        "logPermissions": 1,
        "projectPermissions": 1,
        "serverPermissions": 1,
        "websitePermissions": 1,
        "consolePermissions": 1,
        "dockerPermissions": 1,
        "dockerContainerPermissions": 1
      }
    }
  ]
}

Get an API clients.

get

Requires View API Client or View All API Clients permission.

Authorizations

Path parameters

clientIdstringRequiredDefault: ""

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

HTTPcURLJavaScriptPython

GET /api/clients/{clientId} HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": {
    "id": "text",
    "name": "text",
    "owner_id": "text",
    "is_disabled": true,
    "created_at": "2025-05-12T16:42:04.863Z",
    "token_generated_at": "2025-05-12T16:42:04.863Z",
    "use_custom_permissions": true,
    "allowed_permissions": {
      "teamPermissions": 1,
      "apiPermissions": 1,
      "logPermissions": 1,
      "projectPermissions": 1,
      "serverPermissions": 1,
      "websitePermissions": 1,
      "consolePermissions": 1,
      "dockerPermissions": 1,
      "dockerContainerPermissions": 1
    },
    "custom_permissions": {
      "teamPermissions": 1,
      "apiPermissions": 1,
      "logPermissions": 1,
      "projectPermissions": 1,
      "serverPermissions": 1,
      "websitePermissions": 1,
      "consolePermissions": 1,
      "dockerPermissions": 1,
      "dockerContainerPermissions": 1
    }
  }
}

Get the current API clients.

get

Authorizations

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

HTTPcURLJavaScriptPython

GET /api/clients/@me HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": {
    "id": "text",
    "name": "text",
    "owner_id": "text",
    "is_disabled": true,
    "created_at": "2025-05-12T16:42:04.863Z",
    "token_generated_at": "2025-05-12T16:42:04.863Z",
    "use_custom_permissions": true,
    "allowed_permissions": {
      "teamPermissions": 1,
      "apiPermissions": 1,
      "logPermissions": 1,
      "projectPermissions": 1,
      "serverPermissions": 1,
      "websitePermissions": 1,
      "consolePermissions": 1,
      "dockerPermissions": 1,
      "dockerContainerPermissions": 1
    },
    "custom_permissions": {
      "teamPermissions": 1,
      "apiPermissions": 1,
      "logPermissions": 1,
      "projectPermissions": 1,
      "serverPermissions": 1,
      "websitePermissions": 1,
      "consolePermissions": 1,
      "dockerPermissions": 1,
      "dockerContainerPermissions": 1
    }
  }
}

Get the current API client team.

get

Authorizations

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

HTTPcURLJavaScriptPython

GET /api/clients/@me/team HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": {
    "id": "text",
    "name": "text",
    "created_at": "2025-05-12T16:42:04.863Z",
    "owner_id": "text",
    "vanity_url": "text",
    "icon_url": "text",
    "default_permissions": {
      "teamPermissions": 1,
      "apiPermissions": 1,
      "logPermissions": 1,
      "projectPermissions": 1,
      "serverPermissions": 1,
      "websitePermissions": 1,
      "consolePermissions": 1,
      "dockerPermissions": 1,
      "dockerContainerPermissions": 1
    },
    "default_members_color": "text",
    "require_2fa": true,
    "roles": [
      "text"
    ]
  }
}

Get the current API client owner.

get

Authorizations

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

HTTPcURLJavaScriptPython

GET /api/clients/@me/owner HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": {
    "id": "text",
    "username": "text",
    "displayname": "text",
    "avatar_url": "text",
    "background_url": "text",
    "is_managed": true,
    "created_at": "2025-05-12T16:42:04.863Z"
  }
}

Enable the API clients.

patch

Requires Manage API Client or Manage All API Clients permission.

Authorizations

Path parameters

clientIdstringRequiredDefault: ""

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/clients/{clientId}/enable HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text"
}

Disable the API clients.

patch

Requires Manage API Client or Manage All API Clients permission.

Authorizations

Path parameters

clientIdstringRequiredDefault: ""

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/clients/{clientId}/disable HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text"
}

Delete the API clients.

delete

Requires Manage API Client or Manage All API Clients permission.

Authorizations

Path parameters

clientIdstringRequiredDefault: ""

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/clients/{clientId}/delete HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text"
}