Dokploy

Organization

POST
/organization.create

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

name*string
logo?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/organization.create" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/organization.all

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/organization.all"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/organization.one

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

organizationId*string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/organization.one?organizationId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/organization.update

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

organizationId*string
name*string
logo?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/organization.update" \  -H "Content-Type: application/json" \  -d '{    "organizationId": "string",    "name": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/organization.delete

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

organizationId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/organization.delete" \  -H "Content-Type: application/json" \  -d '{    "organizationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/organization.allInvitations

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/organization.allInvitations"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/organization.removeInvitation

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

invitationId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/organization.removeInvitation" \  -H "Content-Type: application/json" \  -d '{    "invitationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/organization.setDefault

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

organizationId*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/organization.setDefault" \  -H "Content-Type: application/json" \  -d '{    "organizationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Notification

Previous Page

Port

Next Page