Project APIs

Creating and managing accounts, projects, and clients for development.

Retrieve active invitations for the current user.

get

This endpoint returns all active invitations associated with the authenticated user. It is designed to help users manage their invites effectively. Use this to check for any pending invitations that may require action.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/invites

HTTPcURLJavaScriptPython

GET /console/invites HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "text",
    "invite_id": "text",
    "scope": "organization",
    "entity": {
      "id": "text",
      "name": "text"
    },
    "requesting_user_id": "text",
    "requesting_user_email": "text",
    "email": "text",
    "creation_date": "2025-12-16T22:08:08.404Z",
    "expires_date": "2025-12-16T22:08:08.404Z",
    "status": "pending",
    "roles": [
      "text"
    ]
  }
]

Accept an invitation to join an organization.

post

This endpoint allows a user to accept an invitation to join an organization. It is intended for users who have received an invite and need to confirm their participation. Proper authentication is required to ensure that only authorized users can accept invites.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Body

application/json

scopestring · enumOptionalPossible values:

Responses

200

OK

No content

401

Unauthorized

*/*

post

/console/invites

HTTPcURLJavaScriptPython

POST /console/invites HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "scope": "organization",
  "entity": {
    "id": "text",
    "name": "text"
  }
}

No content

Invite a user to an organization

put

This endpoint allows sending an invitation to a user for joining a specific organization. It requires the organization ID and the invite request details. The operation is intended for authenticated users to manage invitations effectively.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

organizationIdstringRequired

Body

application/json

expireDaysinteger · int32Optional

The number of days the invite is valid for before expiring.

securebooleanOptional

If the invite requires users get unique codes to use when registering.

rolesstring[]Optional

The array of roles to assign this user when they join the organization.

emailsstring[]Optional

The emails of the users to invite.

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/console/invites/orgs/{organizationId}

HTTPcURLJavaScriptPython

PUT /console/invites/orgs/{organizationId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "expireDays": 1,
  "secure": true,
  "roles": [
    "text"
  ],
  "emails": [
    "text"
  ]
}

[
  {
    "id": "text",
    "invite_id": "text",
    "scope": "organization",
    "entity": {
      "id": "text",
      "name": "text"
    },
    "requesting_user_id": "text",
    "requesting_user_email": "text",
    "email": "text",
    "creation_date": "2025-12-16T22:08:08.404Z",
    "expires_date": "2025-12-16T22:08:08.404Z",
    "status": "pending",
    "roles": [
      "text"
    ]
  }
]

Invite a user to a specific project

put

This endpoint allows sending an invitation to a user for participation in a specified project. It is designed for project management within the console. Ensure the user has the necessary permissions for the invitation process.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Body

application/json

expireDaysinteger · int32Optional

The number of days the invite is valid for before expiring.

securebooleanOptional

If the invite requires users get unique codes to use when registering.

rolesstring[]Optional

The array of roles to assign this user when they join the organization.

emailsstring[]Optional

The emails of the users to invite.

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/console/invites/projects/{projectId}

HTTPcURLJavaScriptPython

PUT /console/invites/projects/{projectId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "expireDays": 1,
  "secure": true,
  "roles": [
    "text"
  ],
  "emails": [
    "text"
  ]
}

[
  {
    "id": "text",
    "invite_id": "text",
    "scope": "organization",
    "entity": {
      "id": "text",
      "name": "text"
    },
    "requesting_user_id": "text",
    "requesting_user_email": "text",
    "email": "text",
    "creation_date": "2025-12-16T22:08:08.404Z",
    "expires_date": "2025-12-16T22:08:08.404Z",
    "status": "pending",
    "roles": [
      "text"
    ]
  }
]

Create a new project for user accounts

post

This endpoint allows users to create a new project associated with their account. It is essential for managing billing, consent, and overall access to development resources. Ensure that the project details are complete to facilitate proper management and usage.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: projects.create is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Body

application/json

idstringOptional

namestringOptional

customer_idstringOptional

org_idstringOptional

descriptionstringOptional

creation_datestring · date-timeOptional

statusstring · enumOptionalPossible values:

planstringOptional

template_idstringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/console/projects

HTTPcURLJavaScriptPython

POST /console/projects HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2282

{
  "id": "text",
  "name": "text",
  "customer_id": "text",
  "org_id": "text",
  "description": "text",
  "creation_date": "2025-12-16T22:08:08.404Z",
  "owner": {
    "id": "text"
  },
  "app": {
    "id": "text",
    "brand": {
      "name": "text",
      "logo": {
        "filename": "text",
        "url": "https://example.com"
      },
      "dark": {}
    },
    "creation_date": "2025-12-16T22:08:08.404Z",
    "contact": {
      "support_email": "text",
      "developer_emails": [
        "text"
      ]
    },
    "verification": {
      "status": "none",
      "approval": "none",
      "update_date": "2025-12-16T22:08:08.404Z",
      "additional_details": [
        "text"
      ]
    },
    "trust": {
      "status": "none",
      "approval": "none",
      "update_date": "2025-12-16T22:08:08.404Z",
      "additional_details": [
        "text"
      ]
    },
    "links": {
      "home": "https://example.com",
      "privacy": "https://example.com",
      "tos": "https://example.com"
    },
    "domains": [
      "text"
    ],
    "webhooks": {
      "endpoints": [
        {
          "id": "text",
          "uid": "text",
          "external_id": {
            "id": "text"
          },
          "description": "text",
          "disabled": true,
          "secret": "text",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "date_created": "2025-12-16T22:08:08.404Z",
          "date_modified": "2025-12-16T22:08:08.404Z",
          "url": "https://example.com",
          "filter_types": [
            "text"
          ],
          "channels": [
            "text"
          ],
          "rate_limit": 1
        }
      ]
    },
    "request_uris": [
      "text"
    ],
    "consent": {
      "id": "text",
      "scopes": [
        {
          "id": "text",
          "sensitivity": "text",
          "purpose": [
            "COLLECTION"
          ]
        }
      ]
    },
    "agreements": [
      "text"
    ],
    "access_mode": {
      "mode": "private",
      "allow_roles": [
        "text"
      ],
      "deny_roles": [
        "text"
      ]
    }
  },
  "clients": [
    {
      "name": "text",
      "client_id": "text",
      "secret_key": "text",
      "access_token_strategy": "jwt",
      "token_endpoint_auth_method": "client_secret_basic",
      "subject_type": "pairwise",
      "scopes": [
        "text"
      ],
      "audience": [
        "text"
      ],
      "creation_date": "2025-12-16T22:08:08.404Z",
      "status": "enabled",
      "authorized_origins": [
        "text"
      ],
      "authorized_redirect_uris": [
        "text"
      ],
      "access_token_lifespan": "text",
      "id_token_lifespan": "text",
      "refresh_token_lifespan": "text",
      "skip_consent": true
    }
  ],
  "credentials": [
    {
      "name": "text",
      "client_id": "text",
      "secret_key": "text",
      "access_token_strategy": "jwt",
      "token_endpoint_auth_method": "client_secret_basic",
      "creation_date": "2025-12-16T22:08:08.404Z",
      "audience": [
        "text"
      ],
      "status": "enabled"
    }
  ],
  "api_keys": [
    {
      "id": "text",
      "name": "text",
      "key": "text",
      "creation_date": "2025-12-16T22:08:08.404Z",
      "status": "enabled",
      "tags": [
        "text"
      ],
      "restriction": {
        "type": "none",
        "values": [
          "text"
        ]
      }
    }
  ],
  "services": [
    {
      "id": "text"
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "status": "active",
  "plan": "text",
  "template_id": "text"
}

{
  "id": "text",
  "name": "text",
  "customer_id": "text",
  "org_id": "text",
  "description": "text",
  "creation_date": "2025-12-16T22:08:08.404Z",
  "owner": {
    "id": "text"
  },
  "app": {
    "id": "text",
    "brand": {
      "name": "text",
      "logo": {
        "filename": "text",
        "url": "https://example.com"
      },
      "dark": {}
    },
    "creation_date": "2025-12-16T22:08:08.404Z",
    "contact": {
      "support_email": "text",
      "developer_emails": [
        "text"
      ]
    },
    "verification": {
      "status": "none",
      "approval": "none",
      "update_date": "2025-12-16T22:08:08.404Z",
      "additional_details": [
        "text"
      ]
    },
    "trust": {
      "status": "none",
      "approval": "none",
      "update_date": "2025-12-16T22:08:08.404Z",
      "additional_details": [
        "text"
      ]
    },
    "links": {
      "home": "https://example.com",
      "privacy": "https://example.com",
      "tos": "https://example.com"
    },
    "domains": [
      "text"
    ],
    "webhooks": {
      "endpoints": [
        {
          "id": "text",
          "uid": "text",
          "external_id": {
            "id": "text"
          },
          "description": "text",
          "disabled": true,
          "secret": "text",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "date_created": "2025-12-16T22:08:08.404Z",
          "date_modified": "2025-12-16T22:08:08.404Z",
          "url": "https://example.com",
          "filter_types": [
            "text"
          ],
          "channels": [
            "text"
          ],
          "rate_limit": 1
        }
      ]
    },
    "request_uris": [
      "text"
    ],
    "consent": {
      "id": "text",
      "scopes": [
        {
          "id": "text",
          "sensitivity": "text",
          "purpose": [
            "COLLECTION"
          ]
        }
      ]
    },
    "agreements": [
      "text"
    ],
    "access_mode": {
      "mode": "private",
      "allow_roles": [
        "text"
      ],
      "deny_roles": [
        "text"
      ]
    }
  },
  "clients": [
    {
      "name": "text",
      "client_id": "text",
      "secret_key": "text",
      "access_token_strategy": "jwt",
      "token_endpoint_auth_method": "client_secret_basic",
      "subject_type": "pairwise",
      "scopes": [
        "text"
      ],
      "audience": [
        "text"
      ],
      "creation_date": "2025-12-16T22:08:08.404Z",
      "status": "enabled",
      "authorized_origins": [
        "text"
      ],
      "authorized_redirect_uris": [
        "text"
      ],
      "access_token_lifespan": "text",
      "id_token_lifespan": "text",
      "refresh_token_lifespan": "text",
      "skip_consent": true
    }
  ],
  "credentials": [
    {
      "name": "text",
      "client_id": "text",
      "secret_key": "text",
      "access_token_strategy": "jwt",
      "token_endpoint_auth_method": "client_secret_basic",
      "creation_date": "2025-12-16T22:08:08.404Z",
      "audience": [
        "text"
      ],
      "status": "enabled"
    }
  ],
  "api_keys": [
    {
      "id": "text",
      "name": "text",
      "key": "text",
      "creation_date": "2025-12-16T22:08:08.404Z",
      "status": "enabled",
      "tags": [
        "text"
      ],
      "restriction": {
        "type": "none",
        "values": [
          "text"
        ]
      }
    }
  ],
  "services": [
    {
      "id": "text"
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "status": "active",
  "plan": "text",
  "template_id": "text"
}

Get a list of templates a user can select from to bootstrap their project

get

The endpoint allows a user to activate or otherwise bootstrap their project. Each template contains required parameters for them.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/templates

HTTPcURLJavaScriptPython

GET /console/projects/templates HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "image": "text",
    "requires_image": true,
    "description": "text",
    "type": "website",
    "port": 1,
    "protocol": "http",
    "resolver": "http_hostname_header",
    "endpoint_url": "text",
    "documentation_url": "text",
    "required_features": {
      "dns": {
        "zone": "text"
      },
      "git": {
        "git_url": "text"
      },
      "oauth_client": {
        "name": "text",
        "token_auth_method": "text",
        "authorized_domains": [
          "text"
        ],
        "authorized_redirect_uris": [
          "text"
        ]
      },
      "app": {
        "name": "text",
        "logo_url": "text",
        "app_links": {
          "home_page_url": "text",
          "privacy_url": "text",
          "terms_url": "text"
        },
        "domains": [
          "text"
        ],
        "developers": [
          "text"
        ],
        "support_email": "text",
        "scopes": [
          "text"
        ]
      },
      "services": [
        "text"
      ]
    },
    "creation_date": "2025-12-16T22:08:08.404Z",
    "status": "active",
    "manifest_filename": "text",
    "default_machine_type": "text",
    "autoscale": true
  }
]

Returns the template with the specified id.

get

Will return the template metadata for evaluation and provisioning.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

templateIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/templates/{templateId}

HTTPcURLJavaScriptPython

GET /console/projects/templates/{templateId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "image": "text",
  "requires_image": true,
  "description": "text",
  "type": "website",
  "port": 1,
  "protocol": "http",
  "resolver": "http_hostname_header",
  "endpoint_url": "text",
  "documentation_url": "text",
  "required_features": {
    "dns": {
      "zone": "text"
    },
    "git": {
      "git_url": "text"
    },
    "oauth_client": {
      "name": "text",
      "token_auth_method": "text",
      "authorized_domains": [
        "text"
      ],
      "authorized_redirect_uris": [
        "text"
      ]
    },
    "app": {
      "name": "text",
      "logo_url": "text",
      "app_links": {
        "home_page_url": "text",
        "privacy_url": "text",
        "terms_url": "text"
      },
      "domains": [
        "text"
      ],
      "developers": [
        "text"
      ],
      "support_email": "text",
      "scopes": [
        "text"
      ]
    },
    "services": [
      "text"
    ]
  },
  "creation_date": "2025-12-16T22:08:08.404Z",
  "status": "active",
  "manifest_filename": "text",
  "default_machine_type": "text",
  "autoscale": true
}

Retrieve a specific project by its ID

get

This endpoint returns the details of the specified project. It is intended for users to access their own project information. Ensure you have the necessary permissions to view this project.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}

HTTPcURLJavaScriptPython

GET /console/projects/{projectId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "customer_id": "text",
  "org_id": "text",
  "description": "text",
  "creation_date": "2025-12-16T22:08:08.404Z",
  "owner": {
    "id": "text"
  },
  "app": {
    "id": "text",
    "brand": {
      "name": "text",
      "logo": {
        "filename": "text",
        "url": "https://example.com"
      },
      "dark": {}
    },
    "creation_date": "2025-12-16T22:08:08.404Z",
    "contact": {
      "support_email": "text",
      "developer_emails": [
        "text"
      ]
    },
    "verification": {
      "status": "none",
      "approval": "none",
      "update_date": "2025-12-16T22:08:08.404Z",
      "additional_details": [
        "text"
      ]
    },
    "trust": {
      "status": "none",
      "approval": "none",
      "update_date": "2025-12-16T22:08:08.404Z",
      "additional_details": [
        "text"
      ]
    },
    "links": {
      "home": "https://example.com",
      "privacy": "https://example.com",
      "tos": "https://example.com"
    },
    "domains": [
      "text"
    ],
    "webhooks": {
      "endpoints": [
        {
          "id": "text",
          "uid": "text",
          "external_id": {
            "id": "text"
          },
          "description": "text",
          "disabled": true,
          "secret": "text",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "date_created": "2025-12-16T22:08:08.404Z",
          "date_modified": "2025-12-16T22:08:08.404Z",
          "url": "https://example.com",
          "filter_types": [
            "text"
          ],
          "channels": [
            "text"
          ],
          "rate_limit": 1
        }
      ]
    },
    "request_uris": [
      "text"
    ],
    "consent": {
      "id": "text",
      "scopes": [
        {
          "id": "text",
          "sensitivity": "text",
          "purpose": [
            "COLLECTION"
          ]
        }
      ]
    },
    "agreements": [
      "text"
    ],
    "access_mode": {
      "mode": "private",
      "allow_roles": [
        "text"
      ],
      "deny_roles": [
        "text"
      ]
    }
  },
  "clients": [
    {
      "name": "text",
      "client_id": "text",
      "secret_key": "text",
      "access_token_strategy": "jwt",
      "token_endpoint_auth_method": "client_secret_basic",
      "subject_type": "pairwise",
      "scopes": [
        "text"
      ],
      "audience": [
        "text"
      ],
      "creation_date": "2025-12-16T22:08:08.404Z",
      "status": "enabled",
      "authorized_origins": [
        "text"
      ],
      "authorized_redirect_uris": [
        "text"
      ],
      "access_token_lifespan": "text",
      "id_token_lifespan": "text",
      "refresh_token_lifespan": "text",
      "skip_consent": true
    }
  ],
  "credentials": [
    {
      "name": "text",
      "client_id": "text",
      "secret_key": "text",
      "access_token_strategy": "jwt",
      "token_endpoint_auth_method": "client_secret_basic",
      "creation_date": "2025-12-16T22:08:08.404Z",
      "audience": [
        "text"
      ],
      "status": "enabled"
    }
  ],
  "api_keys": [
    {
      "id": "text",
      "name": "text",
      "key": "text",
      "creation_date": "2025-12-16T22:08:08.404Z",
      "status": "enabled",
      "tags": [
        "text"
      ],
      "restriction": {
        "type": "none",
        "values": [
          "text"
        ]
      }
    }
  ],
  "services": [
    {
      "id": "text"
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "status": "active",
  "plan": "text",
  "template_id": "text"
}

Update a specific project for a user

put

This endpoint allows users to update the details of a specified project. It is intended for managing project information related to billing and consent. Ensure that the user has the necessary permissions to make changes to the project.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Body

application/json

idstringOptional

namestringOptional

customer_idstringOptional

org_idstringOptional

descriptionstringOptional

creation_datestring · date-timeOptional

statusstring · enumOptionalPossible values:

planstringOptional

template_idstringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/console/projects/{projectId}

HTTPcURLJavaScriptPython

PUT /console/projects/{projectId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2282

{
  "id": "text",
  "name": "text",
  "customer_id": "text",
  "org_id": "text",
  "description": "text",
  "creation_date": "2025-12-16T22:08:08.404Z",
  "owner": {
    "id": "text"
  },
  "app": {
    "id": "text",
    "brand": {
      "name": "text",
      "logo": {
        "filename": "text",
        "url": "https://example.com"
      },
      "dark": {}
    },
    "creation_date": "2025-12-16T22:08:08.404Z",
    "contact": {
      "support_email": "text",
      "developer_emails": [
        "text"
      ]
    },
    "verification": {
      "status": "none",
      "approval": "none",
      "update_date": "2025-12-16T22:08:08.404Z",
      "additional_details": [
        "text"
      ]
    },
    "trust": {
      "status": "none",
      "approval": "none",
      "update_date": "2025-12-16T22:08:08.404Z",
      "additional_details": [
        "text"
      ]
    },
    "links": {
      "home": "https://example.com",
      "privacy": "https://example.com",
      "tos": "https://example.com"
    },
    "domains": [
      "text"
    ],
    "webhooks": {
      "endpoints": [
        {
          "id": "text",
          "uid": "text",
          "external_id": {
            "id": "text"
          },
          "description": "text",
          "disabled": true,
          "secret": "text",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "date_created": "2025-12-16T22:08:08.404Z",
          "date_modified": "2025-12-16T22:08:08.404Z",
          "url": "https://example.com",
          "filter_types": [
            "text"
          ],
          "channels": [
            "text"
          ],
          "rate_limit": 1
        }
      ]
    },
    "request_uris": [
      "text"
    ],
    "consent": {
      "id": "text",
      "scopes": [
        {
          "id": "text",
          "sensitivity": "text",
          "purpose": [
            "COLLECTION"
          ]
        }
      ]
    },
    "agreements": [
      "text"
    ],
    "access_mode": {
      "mode": "private",
      "allow_roles": [
        "text"
      ],
      "deny_roles": [
        "text"
      ]
    }
  },
  "clients": [
    {
      "name": "text",
      "client_id": "text",
      "secret_key": "text",
      "access_token_strategy": "jwt",
      "token_endpoint_auth_method": "client_secret_basic",
      "subject_type": "pairwise",
      "scopes": [
        "text"
      ],
      "audience": [
        "text"
      ],
      "creation_date": "2025-12-16T22:08:08.404Z",
      "status": "enabled",
      "authorized_origins": [
        "text"
      ],
      "authorized_redirect_uris": [
        "text"
      ],
      "access_token_lifespan": "text",
      "id_token_lifespan": "text",
      "refresh_token_lifespan": "text",
      "skip_consent": true
    }
  ],
  "credentials": [
    {
      "name": "text",
      "client_id": "text",
      "secret_key": "text",
      "access_token_strategy": "jwt",
      "token_endpoint_auth_method": "client_secret_basic",
      "creation_date": "2025-12-16T22:08:08.404Z",
      "audience": [
        "text"
      ],
      "status": "enabled"
    }
  ],
  "api_keys": [
    {
      "id": "text",
      "name": "text",
      "key": "text",
      "creation_date": "2025-12-16T22:08:08.404Z",
      "status": "enabled",
      "tags": [
        "text"
      ],
      "restriction": {
        "type": "none",
        "values": [
          "text"
        ]
      }
    }
  ],
  "services": [
    {
      "id": "text"
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "status": "active",
  "plan": "text",
  "template_id": "text"
}

{
  "id": "text",
  "name": "text",
  "customer_id": "text",
  "org_id": "text",
  "description": "text",
  "creation_date": "2025-12-16T22:08:08.404Z",
  "owner": {
    "id": "text"
  },
  "app": {
    "id": "text",
    "brand": {
      "name": "text",
      "logo": {
        "filename": "text",
        "url": "https://example.com"
      },
      "dark": {}
    },
    "creation_date": "2025-12-16T22:08:08.404Z",
    "contact": {
      "support_email": "text",
      "developer_emails": [
        "text"
      ]
    },
    "verification": {
      "status": "none",
      "approval": "none",
      "update_date": "2025-12-16T22:08:08.404Z",
      "additional_details": [
        "text"
      ]
    },
    "trust": {
      "status": "none",
      "approval": "none",
      "update_date": "2025-12-16T22:08:08.404Z",
      "additional_details": [
        "text"
      ]
    },
    "links": {
      "home": "https://example.com",
      "privacy": "https://example.com",
      "tos": "https://example.com"
    },
    "domains": [
      "text"
    ],
    "webhooks": {
      "endpoints": [
        {
          "id": "text",
          "uid": "text",
          "external_id": {
            "id": "text"
          },
          "description": "text",
          "disabled": true,
          "secret": "text",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "date_created": "2025-12-16T22:08:08.404Z",
          "date_modified": "2025-12-16T22:08:08.404Z",
          "url": "https://example.com",
          "filter_types": [
            "text"
          ],
          "channels": [
            "text"
          ],
          "rate_limit": 1
        }
      ]
    },
    "request_uris": [
      "text"
    ],
    "consent": {
      "id": "text",
      "scopes": [
        {
          "id": "text",
          "sensitivity": "text",
          "purpose": [
            "COLLECTION"
          ]
        }
      ]
    },
    "agreements": [
      "text"
    ],
    "access_mode": {
      "mode": "private",
      "allow_roles": [
        "text"
      ],
      "deny_roles": [
        "text"
      ]
    }
  },
  "clients": [
    {
      "name": "text",
      "client_id": "text",
      "secret_key": "text",
      "access_token_strategy": "jwt",
      "token_endpoint_auth_method": "client_secret_basic",
      "subject_type": "pairwise",
      "scopes": [
        "text"
      ],
      "audience": [
        "text"
      ],
      "creation_date": "2025-12-16T22:08:08.404Z",
      "status": "enabled",
      "authorized_origins": [
        "text"
      ],
      "authorized_redirect_uris": [
        "text"
      ],
      "access_token_lifespan": "text",
      "id_token_lifespan": "text",
      "refresh_token_lifespan": "text",
      "skip_consent": true
    }
  ],
  "credentials": [
    {
      "name": "text",
      "client_id": "text",
      "secret_key": "text",
      "access_token_strategy": "jwt",
      "token_endpoint_auth_method": "client_secret_basic",
      "creation_date": "2025-12-16T22:08:08.404Z",
      "audience": [
        "text"
      ],
      "status": "enabled"
    }
  ],
  "api_keys": [
    {
      "id": "text",
      "name": "text",
      "key": "text",
      "creation_date": "2025-12-16T22:08:08.404Z",
      "status": "enabled",
      "tags": [
        "text"
      ],
      "restriction": {
        "type": "none",
        "values": [
          "text"
        ]
      }
    }
  ],
  "services": [
    {
      "id": "text"
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "status": "active",
  "plan": "text",
  "template_id": "text"
}

Delete a specific project owned by the user

delete

This endpoint allows users to delete a project they own. It ensures that only authorized users can remove their projects, maintaining the integrity of project management. Use this operation to manage your projects effectively and ensure proper billing and consent management.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: projects.delete is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/console/projects/{projectId}

HTTPcURLJavaScriptPython

DELETE /console/projects/{projectId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Retrieve application details for a specific project.

get

This endpoint retrieves the details of an application configured for the specified project. It is intended for users with appropriate permissions to access application information. Ensure that the projectId and appId are valid to receive the correct application data.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

appIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/apps/{appId}

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/apps/{appId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "brand": {
    "name": "text",
    "logo": {
      "filename": "text",
      "url": "https://example.com"
    },
    "dark": {}
  },
  "creation_date": "2025-12-16T22:08:08.404Z",
  "contact": {
    "support_email": "text",
    "developer_emails": [
      "text"
    ]
  },
  "verification": {
    "status": "none",
    "approval": "none",
    "update_date": "2025-12-16T22:08:08.404Z",
    "additional_details": [
      "text"
    ]
  },
  "trust": {
    "status": "none",
    "approval": "none",
    "update_date": "2025-12-16T22:08:08.404Z",
    "additional_details": [
      "text"
    ]
  },
  "links": {
    "home": "https://example.com",
    "privacy": "https://example.com",
    "tos": "https://example.com"
  },
  "domains": [
    "text"
  ],
  "webhooks": {
    "endpoints": [
      {
        "id": "text",
        "uid": "text",
        "external_id": {
          "id": "text"
        },
        "description": "text",
        "disabled": true,
        "secret": "text",
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "date_created": "2025-12-16T22:08:08.404Z",
        "date_modified": "2025-12-16T22:08:08.404Z",
        "url": "https://example.com",
        "filter_types": [
          "text"
        ],
        "channels": [
          "text"
        ],
        "rate_limit": 1
      }
    ]
  },
  "request_uris": [
    "text"
  ],
  "consent": {
    "id": "text",
    "scopes": [
      {
        "id": "text",
        "sensitivity": "text",
        "purpose": [
          "COLLECTION"
        ]
      }
    ]
  },
  "agreements": [
    "text"
  ],
  "access_mode": {
    "mode": "private",
    "allow_roles": [
      "text"
    ],
    "deny_roles": [
      "text"
    ]
  }
}

List APIs enabled for the project

get

Retrieves a list of API services that are enabled for the specified project. This operation is essential for managing API access and ensuring proper usage within the project's scope. It helps in monitoring and controlling the API subscriptions effectively.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/gateway

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/gateway HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "text"
  }
]

Retrieve activated service ID for project

get

Fetch the service ID associated with the specified project if it is activated. This endpoint is crucial for managing API subscriptions and ensuring proper access control for project resources.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

serviceIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/gateway/{serviceId}

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/gateway/{serviceId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text"
}

Enable API subscription for a project service.

post

This endpoint allows enabling a specific API subscription for a project. It updates the state of the subscription key, granting access to the associated operations. This functionality is crucial for managing project resources effectively and ensuring compliance with rate limiting and billing requirements.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

serviceIdstringRequired

Responses

200

OK

*/*

Responseboolean

401

Unauthorized

*/*

post

/console/projects/{projectId}/gateway/{serviceId}

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/gateway/{serviceId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

true

Disable a specific API subscription for a project

delete

This endpoint allows you to disable an API subscription associated with a specific project. It ensures that the specified service is no longer accessible, helping to manage resource usage and access control effectively.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

serviceIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/console/projects/{projectId}/gateway/{serviceId}

HTTPcURLJavaScriptPython

DELETE /console/projects/{projectId}/gateway/{serviceId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Given the project will retrieve any active notifications.

get

Will return active notifications, note that on the client side, use something like local storage to indicate the user read the message.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

The project ID

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/notifications

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/notifications HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "id": "text",
    "title": "text",
    "topic_id": "text",
    "description": "text",
    "url": "text",
    "timestamp": "2025-12-16T22:08:08.404Z",
    "source": "text",
    "level": "info",
    "topic": "build",
    "status": "started"
  }
}

Runs a deployment to docker for the given project.

post

This will create and setup the organization (if not already) as well as deploy the project into the docker instance. After complete the docker instance will be available (but not yet bound) to any loadbalancer or port.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

The project ID

topicstring · enumRequired

The topic for this particular notification

Possible values:

topicIdstringRequired

The unique ID that related topics converge on for 'latest' message on that subject.

Body

application/json

idstringOptional

titlestringOptional

topic_idstringOptional

descriptionstringOptional

urlstringOptional

timestampstring · date-timeOptional

sourcestringOptional

levelstring · enumOptionalPossible values:

topicstring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

Responses

200

OK

No content

401

Unauthorized

*/*

post

/console/projects/{projectId}/notifications/{topic}/{topicId}

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/notifications/{topic}/{topicId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "id": "text",
  "title": "text",
  "topic_id": "text",
  "description": "text",
  "url": "text",
  "timestamp": "2025-12-16T22:08:08.404Z",
  "source": "text",
  "level": "info",
  "topic": "build",
  "status": "started"
}

No content

Retrieve public profile for a specific project

get

This endpoint returns the metadata associated with the specified project. It provides essential information for users to understand project details and access levels. Ideal for use in billing, consent management, and overall project oversight.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/profile

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/profile HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "brand": {
    "name": "text",
    "logo": {
      "filename": "text",
      "url": "https://example.com"
    },
    "dark": {}
  },
  "contact": {
    "support_email": "text",
    "developer_emails": [
      "text"
    ]
  },
  "links": {
    "home": "https://example.com",
    "privacy": "https://example.com",
    "tos": "https://example.com"
  }
}

Modify project details for user accounts

put

Allows users to update project name and associated metadata. This operation is essential for maintaining accurate project information, ensuring proper billing, consent management, and overall project oversight. It is designed for user accounts to manage their projects effectively.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Body

application/json

namestringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/console/projects/{projectId}/profile

HTTPcURLJavaScriptPython

PUT /console/projects/{projectId}/profile HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "text",
  "name": "text",
  "customer_id": "text",
  "org_id": "text",
  "description": "text",
  "creation_date": "2025-12-16T22:08:08.404Z",
  "owner": {
    "id": "text"
  },
  "app": {
    "id": "text",
    "brand": {
      "name": "text",
      "logo": {
        "filename": "text",
        "url": "https://example.com"
      },
      "dark": {}
    },
    "creation_date": "2025-12-16T22:08:08.404Z",
    "contact": {
      "support_email": "text",
      "developer_emails": [
        "text"
      ]
    },
    "verification": {
      "status": "none",
      "approval": "none",
      "update_date": "2025-12-16T22:08:08.404Z",
      "additional_details": [
        "text"
      ]
    },
    "trust": {
      "status": "none",
      "approval": "none",
      "update_date": "2025-12-16T22:08:08.404Z",
      "additional_details": [
        "text"
      ]
    },
    "links": {
      "home": "https://example.com",
      "privacy": "https://example.com",
      "tos": "https://example.com"
    },
    "domains": [
      "text"
    ],
    "webhooks": {
      "endpoints": [
        {
          "id": "text",
          "uid": "text",
          "external_id": {
            "id": "text"
          },
          "description": "text",
          "disabled": true,
          "secret": "text",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "date_created": "2025-12-16T22:08:08.404Z",
          "date_modified": "2025-12-16T22:08:08.404Z",
          "url": "https://example.com",
          "filter_types": [
            "text"
          ],
          "channels": [
            "text"
          ],
          "rate_limit": 1
        }
      ]
    },
    "request_uris": [
      "text"
    ],
    "consent": {
      "id": "text",
      "scopes": [
        {
          "id": "text",
          "sensitivity": "text",
          "purpose": [
            "COLLECTION"
          ]
        }
      ]
    },
    "agreements": [
      "text"
    ],
    "access_mode": {
      "mode": "private",
      "allow_roles": [
        "text"
      ],
      "deny_roles": [
        "text"
      ]
    }
  },
  "clients": [
    {
      "name": "text",
      "client_id": "text",
      "secret_key": "text",
      "access_token_strategy": "jwt",
      "token_endpoint_auth_method": "client_secret_basic",
      "subject_type": "pairwise",
      "scopes": [
        "text"
      ],
      "audience": [
        "text"
      ],
      "creation_date": "2025-12-16T22:08:08.404Z",
      "status": "enabled",
      "authorized_origins": [
        "text"
      ],
      "authorized_redirect_uris": [
        "text"
      ],
      "access_token_lifespan": "text",
      "id_token_lifespan": "text",
      "refresh_token_lifespan": "text",
      "skip_consent": true
    }
  ],
  "credentials": [
    {
      "name": "text",
      "client_id": "text",
      "secret_key": "text",
      "access_token_strategy": "jwt",
      "token_endpoint_auth_method": "client_secret_basic",
      "creation_date": "2025-12-16T22:08:08.404Z",
      "audience": [
        "text"
      ],
      "status": "enabled"
    }
  ],
  "api_keys": [
    {
      "id": "text",
      "name": "text",
      "key": "text",
      "creation_date": "2025-12-16T22:08:08.404Z",
      "status": "enabled",
      "tags": [
        "text"
      ],
      "restriction": {
        "type": "none",
        "values": [
          "text"
        ]
      }
    }
  ],
  "services": [
    {
      "id": "text"
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "status": "active",
  "plan": "text",
  "template_id": "text"
}

Retrieve users linked to a specific project

get

This endpoint returns a list of users associated with the specified project, along with their respective roles. It is designed for internal use to manage project user access effectively. Ensure you have the necessary permissions to access this information.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/users

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/users HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "traits": {
      "name": {
        "given_name": "text",
        "family_name": "text",
        "middle_name": "text"
      },
      "birthdate": "2025-12-16",
      "email": "text",
      "username": "text",
      "gender": "male",
      "citizenship": "text",
      "locale": "text"
    },
    "metadata_public": {
      "picture": "text"
    }
  }
]