Koyeb REST API

https://www.koyeb.com/docs/reference/api
Admin
Koyeb REST API allows developers to programmatically interact with the Koyeb platform using...
Tokens:3,023
Snippets:31
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /v1/apps

Source: https://www.koyeb.com/docs/reference/api

Retrieves a list of all applications associated with the authenticated organization.

```APIDOC
## GET /v1/apps

### Description
Retrieves a list of applications available in the user's organization.

### Method
GET

### Endpoint
https://app.koyeb.com/v1/apps

### Response
#### Success Response (200)
- **apps** (array) - List of application objects
- **limit** (integer) - The maximum number of results returned
- **offset** (integer) - The starting index for the results
- **count** (integer) - The total number of applications

#### Response Example
{
  "apps": [
    {
      "id": "e267e09d-a2ef-4672-95c7-bf88d787a274",
      "name": "demo",
      "organization_id": "c402bcad-d06d-4fd6-8af2-08b790c0e249",
      "updated_at": "2021-04-26T08:28:59.221274Z",
      "created_at": "2021-04-26T08:28:59.221274Z",
      "domains": [
        {
          "name": "demo-koyeb.koyeb.app",
          "deployment_group": "prod"
        }
      ]
    }
  ],
  "limit": 20,
  "offset": 0,
  "count": 2
}
```

--------------------------------

### GET /v1/account/activities

Source: https://www.koyeb.com/docs/reference/api

Retrieves a list of account activities for the authenticated user.

```APIDOC
## GET /v1/account/activities

### Description
Retrieves a list of account activities.

### Method
GET

### Endpoint
/v1/account/activities

### Parameters
#### Query Parameters
- **limit** (string) - Optional - The maximum number of items to return.
- **offset** (string) - Optional - The number of items to skip.
```

--------------------------------

### Retrieve list of Apps via cURL

Source: https://www.koyeb.com/docs/reference/api

Example request to fetch all applications using the Koyeb API with an authorization header.

```shell
%curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps
{
  "apps": [
    {
      "id": "e267e09d-a2ef-4672-95c7-bf88d787a274",
      "name": "demo",
      "organization_id": "c402bcad-d06d-4fd6-8af2-08b790c0e249",
      "updated_at": "2021-04-26T08:28:59.221274Z",
      "created_at": "2021-04-26T08:28:59.221274Z",
      "domains": [
        {
          "name": "demo-koyeb.koyeb.app",
          "deployment_group": "prod"
        }
      ]
    },
    {
      "id": "e38caea5-5acb-4fec-aa65-81749546b470",
      "name": "www",
      "organization_id": "c402bcad-d06d-4fd6-8af2-08b790c0e249",
      "updated_at": "2021-05-04T08:56:40.557792Z",
      "created_at": "2021-05-04T08:56:40.557792Z",
      "domains": [
        {
          "name": "www-koyeb.koyeb.app",
          "deployment_group": "prod"
        }
      ]
    }
  ],
  "limit": 20,
  "offset": 0,
  "count": 2
}
```

--------------------------------

### 404 Not Found Error Response

Source: https://www.koyeb.com/docs/reference/api

Example of a 404 error response returned when the requested resource does not exist.

```json
{
  "status": 404,
  "code": "unknown_resource",
  "message": "App not found"
}
```

--------------------------------

### Organization Operations

Source: https://www.koyeb.com/docs/reference/api

Operations for managing organizations, GitHub installations, and budgets.

```APIDOC
## GET /v1/github/installation
## POST /v1/github/installation
## POST /v1/organizations
## GET /v1/organizations/{id}
## DELETE /v1/organizations/{id}
## PUT /v1/organizations/{id}
## PATCH /v1/organizations/{id}
## POST /v1/organizations/{id}/access_token
## POST /v1/organizations/{id}/deactivate
## PUT /v1/organizations/{id}/default_project
## PUT /v1/organizations/{id}/name
## POST /v1/organizations/{id}/plan
## POST /v1/organizations/{id}/reactivate
## POST /v1/organizations/{id}/signup_qualification
## POST /v1/organizations/{id}/switch
## GET /v1/organizations/{organization_id}/budget
## DELETE /v1/organizations/{organization_id}/budget
## POST /v1/organizations/{organization_id}/budget
## PUT /v1/organizations/{organization_id}/budget
## POST /v1/unscope_organization_token
```

--------------------------------

### GET /v1/subscriptions/{id}

Source: https://www.koyeb.com/docs/reference/api

Retrieves details for a specific subscription.

```APIDOC
## GET /v1/subscriptions/{id}

### Description
Retrieves details for a specific subscription.

### Method
GET

### Endpoint
/v1/subscriptions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the subscription.
```

--------------------------------

### 403 Forbidden Error Response

Source: https://www.koyeb.com/docs/reference/api

Example of a 403 error response indicating insufficient permissions to access the requested resource.

```json
{
  "status": 403,
  "code": "authentication_required",
  "message": "You don't have the requested permission to access to resource."
}
```

--------------------------------

### 401 Unauthorized Error Response

Source: https://www.koyeb.com/docs/reference/api

Example of a 401 error response returned when a request is missing or has an invalid bearer token.

```json
{
  "status": 401,
  "code": "authentication_error",
  "message": "Request unauthenticated with bearer"
}
```

--------------------------------

### 400 Bad Request Error Response

Source: https://www.koyeb.com/docs/reference/api

Example of a 400 error response indicating invalid arguments, including specific field validation errors.

```json
{
  "status": 400,
  "code": "invalid_argument",
  "message": "Invalid argument",
  "fields": [
    {
      "field": "definition.docker.image",
      "description": "cannot be blank"
    }
  ]
}
```

--------------------------------

### Activity API

Source: https://www.koyeb.com/docs/reference/api

Endpoints for retrieving account and system activities.

```APIDOC
## GET /v1/account/activities
List account activities.

## GET /v1/activities
List system activities.

## GET /v1/notifications
List notifications.
```

--------------------------------

### Apps API

Source: https://www.koyeb.com/docs/reference/api

Endpoints for managing applications.

```APIDOC
## GET /v1/app_events
List application events.

## GET /v1/apps
List all apps.

## POST /v1/apps
Create a new app.

## GET /v1/apps/{id}
Get a specific app.

## DELETE /v1/apps/{id}
Delete an app.

## PUT /v1/apps/{id}
Update an app.

## PATCH /v1/apps/{id}
Partially update an app.

## POST /v1/apps/{id}/pause
Pause an app.

## POST /v1/apps/{id}/resume
Resume an app.
```

--------------------------------

### Deployments API

Source: https://www.koyeb.com/docs/reference/api

Operations for managing and monitoring application deployments.

```APIDOC
## GET /v1/deployments

### Description
Retrieve a list of all deployments.

### Method
GET

### Endpoint
/v1/deployments
```

--------------------------------

### Services API

Source: https://www.koyeb.com/docs/reference/api

Endpoints for managing services.

```APIDOC
## GET /v1/service_events
List service events.

## GET /v1/services
List all services.

## POST /v1/services
Create a new service.

## POST /v1/services-autocomplete
Autocomplete service names.

## GET /v1/services/{id}
Get a specific service.

## DELETE /v1/services/{id}
Delete a service.

## PUT /v1/services/{id}
Update a service.

## PATCH /v1/services/{id}
Partially update a service.

## POST /v1/services/{id}/pause
Pause a service.

## POST /v1/services/{id}/redeploy
Redeploy a service.

## POST /v1/services/{id}/resume
Resume a service.

## GET /v1/services/{id}/scale
Get service scale settings.

## DELETE /v1/services/{id}/scale
Delete service scale settings.

## PUT /v1/services/{id}/scale
Update service scale settings.
```

--------------------------------

### Credentials API

Source: https://www.koyeb.com/docs/reference/api

Endpoints for managing credentials.

```APIDOC
## GET /v1/credentials
List all credentials.

## POST /v1/credentials
Create a new credential.

## GET /v1/credentials/{id}
Get a specific credential.

## DELETE /v1/credentials/{id}
Delete a specific credential.

## PUT /v1/credentials/{id}
Update a specific credential.

## PATCH /v1/credentials/{id}
Partially update a specific credential.
```

--------------------------------

### Pagination Parameters

Source: https://www.koyeb.com/docs/reference/api

Standard query parameters used for paginated responses across top-level API resources.

```APIDOC
### Pagination

#### Query Parameters
- **limit** (integer) - Optional - A positive integer lower or equal to 100 to select the number of items to display.
- **offset** (integer) - Optional - An integer to indicate the position to start at.
```

--------------------------------

### OrganizationInvitations Operations

Source: https://www.koyeb.com/docs/reference/api

Operations for managing organization invitations.

```APIDOC
## GET /v1/organization_invitations
## POST /v1/organization_invitations
## GET /v1/organization_invitations/{id}
## DELETE /v1/organization_invitations/{id}
## POST /v1/organization_invitations/{id}/resend
```

--------------------------------

### PersistentVolumes API

Source: https://www.koyeb.com/docs/reference/api

Operations for managing persistent volumes.

```APIDOC
## GET /v1/volumes

### Description
Retrieve a list of all persistent volumes.

### Method
GET

### Endpoint
/v1/volumes

## POST /v1/volumes

### Description
Create a new persistent volume.

### Method
POST

### Endpoint
/v1/volumes
```

--------------------------------

### Coupons API

Source: https://www.koyeb.com/docs/reference/api

Endpoints for managing coupons.

```APIDOC
## POST /v1/coupons
Creates a new coupon.

## GET /v1/coupons/{code}
Retrieves details for a specific coupon by code.
```

--------------------------------

### Projects Operations

Source: https://www.koyeb.com/docs/reference/api

Operations for managing projects.

```APIDOC
## GET /v1/projects
## POST /v1/projects
## GET /v1/projects/{id}
## DELETE /v1/projects/{id}
## PUT /v1/projects/{id}
## PATCH /v1/projects/{id}
```

--------------------------------

### Users Operations

Source: https://www.koyeb.com/docs/reference/api

Operations for managing user accounts.

```APIDOC
## DELETE /v1/users/{id}
## DELETE /v2/users/{id}
```

--------------------------------

### POST /v1/organization_confirmations/{id}

Source: https://www.koyeb.com/docs/reference/api

Confirms an organization using the provided ID.

```APIDOC
## POST /v1/organization_confirmations/{id}

### Description
Confirms an organization.

### Method
POST

### Endpoint
/v1/organization_confirmations/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the organization confirmation.
```

--------------------------------

### Domains API

Source: https://www.koyeb.com/docs/reference/api

Operations for managing custom domains.

```APIDOC
## GET /v1/domains

### Description
Retrieve a list of all domains.

### Method
GET

### Endpoint
/v1/domains

## POST /v1/domains

### Description
Create a new domain.

### Method
POST

### Endpoint
/v1/domains
```

--------------------------------

### OrganizationMembers Operations

Source: https://www.koyeb.com/docs/reference/api

Operations for managing organization members.

```APIDOC
## GET /v1/organization_members
## DELETE /v1/organization_members/{id}
```

--------------------------------

### Secrets API

Source: https://www.koyeb.com/docs/reference/api

Endpoints for managing secrets.

```APIDOC
## GET /v1/secrets
List all secrets.

## POST /v1/secrets
Create a new secret.

## GET /v1/secrets/{id}
Get a specific secret.

## DELETE /v1/secrets/{id}
Delete a specific secret.

## PUT /v1/secrets/{id}
Update a specific secret.

## PATCH /v1/secrets/{id}
Partially update a specific secret.

## POST /v1/secrets/{id}/reveal
Reveal a specific secret.
```
Tokens:
Raw