### Retrieve List of Apps

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

Example request using cURL to fetch all applications associated with the authenticated account.

```bash
%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
}
```

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

### Instances API

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

Operations for managing instances, including retrieving instance events, listing instances, getting specific instances, and executing commands on instances.

```APIDOC
## GET /v1/instance_events

### Description
Retrieves a list of events related to instances.

### Method
GET

### Endpoint
/v1/instance_events

## GET /v1/instances

### Description
Retrieves a list of all instances.

### Method
GET

### Endpoint
/v1/instances

## GET /v1/instances/{id}

### Description
Retrieves a specific instance by its ID.

### Method
GET

### Endpoint
/v1/instances/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the instance.

## GET /v1/streams/instances/exec

### Description
Executes a command on a specific instance via a stream.

### Method
GET

### Endpoint
/v1/streams/instances/exec
```

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

### RegionalDeployments API

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

Operations for managing regional deployments, including retrieving events, listing regional deployments, and getting specific regional deployments.

```APIDOC
## GET /v1/regional_deployment_events

### Description
Retrieves a list of events related to regional deployments.

### Method
GET

### Endpoint
/v1/regional_deployment_events

## GET /v1/regional_deployments

### Description
Retrieves a list of all regional deployments.

### Method
GET

### Endpoint
/v1/regional_deployments

## GET /v1/regional_deployments/{id}

### Description
Retrieves a specific regional deployment by its ID.

### Method
GET

### Endpoint
/v1/regional_deployments/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the regional deployment.
```

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

### List Apps

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

Retrieves a list of all applications associated with your Koyeb account.

```APIDOC
## GET /v1/apps

### Description
Retrieves a list of applications.

### Method
GET

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

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of applications to return.
- **offset** (integer) - Optional - The number of applications to skip before starting to collect the result set.

### Request Example
```bash
%curl -H 'Authorization: Bearer YOUR_API_KEY' https://app.koyeb.com/v1/apps
```

### Response
#### Success Response (200)
- **apps** (array) - A list of application objects.
- **limit** (integer) - The limit applied to the result set.
- **offset** (integer) - The offset applied to the result set.
- **count** (integer) - The total number of applications matching the query.

#### Response Example
```json
{
  "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
}
```
```

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

### DockerHelper API

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

Operations for Docker helper functionalities, specifically for verifying Docker configurations.

```APIDOC
## GET /v1/docker-helper/verify

### Description
Verifies Docker configuration.

### Method
GET

### Endpoint
/v1/docker-helper/verify
```

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

### Pagination and Error Handling

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

Overview of standard API behaviors including pagination parameters and common error response structures.

```APIDOC
## Pagination

### Description
Top-level API resources support pagination using query parameters.

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

## Error Responses

### Description
Standard error responses returned by the API.

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

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

### List Activities

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

Retrieves a list of activities with optional filtering by type and pagination.

```APIDOC
## GET /v1/activities

### Description
List Activities

### Method
GET

### Endpoint
/v1/activities

### Query Parameters
- **limit** (integer) - Optional - The maximum number of activities to return.
- **offset** (integer) - Optional - The number of activities to skip before returning results.
- **types** (string) - Optional - A comma-separated list of activity types to filter by.
```

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

### Apps API

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

Operations related to managing Koyeb Apps, including listing, creating, retrieving, updating, and deleting apps, as well as pausing and resuming them.

```APIDOC
## GET /v1/app_events

### Description
Retrieves a list of events related to apps.

### Method
GET

### Endpoint
/v1/app_events

## GET /v1/apps

### Description
Retrieves a list of all apps.

### Method
GET

### Endpoint
/v1/apps

## POST /v1/apps

### Description
Creates a new app.

### Method
POST

### Endpoint
/v1/apps

## GET /v1/apps/{id}

### Description
Retrieves a specific app by its ID.

### Method
GET

### Endpoint
/v1/apps/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the app.

## DELETE /v1/apps/{id}

### Description
Deletes a specific app by its ID.

### Method
DELETE

### Endpoint
/v1/apps/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the app.

## PUT /v1/apps/{id}

### Description
Updates a specific app by its ID.

### Method
PUT

### Endpoint
/v1/apps/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the app.

## PATCH /v1/apps/{id}

### Description
Partially updates a specific app by its ID.

### Method
PATCH

### Endpoint
/v1/apps/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the app.

## POST /v1/apps/{id}/pause

### Description
Pauses a specific app by its ID.

### Method
POST

### Endpoint
/v1/apps/{id}/pause

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the app.

## POST /v1/apps/{id}/resume

### Description
Resumes a specific app by its ID.

### Method
POST

### Endpoint
/v1/apps/{id}/resume

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the app.
```

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

### CatalogInstances API

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

Operations for managing catalog instances, including listing and retrieving specific catalog instances.

```APIDOC
## GET /v1/catalog/instances

### Description
Retrieves a list of catalog instances.

### Method
GET

### Endpoint
/v1/catalog/instances

## GET /v1/catalog/instances/{id}

### Description
Retrieves a specific catalog instance by its ID.

### Method
GET

### Endpoint
/v1/catalog/instances/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the catalog instance.
```

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

### Deployments API

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

Operations for managing Koyeb Deployments, including retrieving deployment scaling information, events, and specific deployments, as well as canceling deployments.

```APIDOC
## GET /v1/deployment/{id}/scaling

### Description
Retrieves the scaling configuration for a specific deployment.

### Method
GET

### Endpoint
/v1/deployment/{id}/scaling

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the deployment.

## GET /v1/deployment_events

### Description
Retrieves a list of events related to deployments.

### Method
GET

### Endpoint
/v1/deployment_events

## GET /v1/deployments

### Description
Retrieves a list of all deployments.

### Method
GET

### Endpoint
/v1/deployments

## GET /v1/deployments/{id}

### Description
Retrieves a specific deployment by its ID.

### Method
GET

### Endpoint
/v1/deployments/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the deployment.

## POST /v1/deployments/{id}/cancel

### Description
Cancels a specific deployment by its ID.

### Method
POST

### Endpoint
/v1/deployments/{id}/cancel

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the deployment.
```

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

### Compose API

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

Operations for managing compose deployments.

```APIDOC
## POST /v1/compose

### Description
Creates a new compose deployment.

### Method
POST

### Endpoint
/v1/compose
```

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

### Services API

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

Operations for managing Koyeb Services, including listing, creating, updating, deleting, pausing, resuming, and redeploying services.

```APIDOC
## GET /v1/service_events

### Description
Retrieves a list of events related to services.

### Method
GET

### Endpoint
/v1/service_events

## GET /v1/services

### Description
Retrieves a list of all services.

### Method
GET

### Endpoint
/v1/services

## POST /v1/services

### Description
Creates a new service.

### Method
POST

### Endpoint
/v1/services

## POST /v1/services-autocomplete

### Description
Provides autocomplete suggestions for services.

### Method
POST

### Endpoint
/v1/services-autocomplete

## GET /v1/services/{id}

### Description
Retrieves a specific service by its ID.

### Method
GET

### Endpoint
/v1/services/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

## DELETE /v1/services/{id}

### Description
Deletes a specific service by its ID.

### Method
DELETE

### Endpoint
/v1/services/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

## PUT /v1/services/{id}

### Description
Updates a specific service by its ID.

### Method
PUT

### Endpoint
/v1/services/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

## PATCH /v1/services/{id}

### Description
Partially updates a specific service by its ID.

### Method
PATCH

### Endpoint
/v1/services/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

## POST /v1/services/{id}/pause

### Description
Pauses a specific service by its ID.

### Method
POST

### Endpoint
/v1/services/{id}/pause

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

## POST /v1/services/{id}/redeploy

### Description
Redeploys a specific service by its ID.

### Method
POST

### Endpoint
/v1/services/{id}/redeploy

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

## POST /v1/services/{id}/resume

### Description
Resumes a specific service by its ID.

### Method
POST

### Endpoint
/v1/services/{id}/resume

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

## GET /v1/services/{id}/scale

### Description
Retrieves the scaling configuration of a specific service by its ID.

### Method
GET

### Endpoint
/v1/services/{id}/scale

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

## DELETE /v1/services/{id}/scale

### Description
Deletes the scaling configuration of a specific service by its ID.

### Method
DELETE

### Endpoint
/v1/services/{id}/scale

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

## PUT /v1/services/{id}/scale

### Description
Updates the scaling configuration of a specific service by its ID.

### Method
PUT

### Endpoint
/v1/services/{id}/scale

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.
```

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

### Summary API

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

Operations for retrieving organization summary information.

```APIDOC
## GET /v1/organizations/{organization_id}/summary

### Description
Retrieves a summary for a specific organization.

### Method
GET

### Endpoint
/v1/organizations/{organization_id}/summary

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The unique identifier of the organization.
```

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

### Usages API

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

Operations for retrieving usage data, including general usage and detailed usage.

```APIDOC
## GET /v1/usages

### Description
Retrieves general usage data.

### Method
GET

### Endpoint
/v1/usages

## GET /v1/usages/details

### Description
Retrieves detailed usage data.

### Method
GET

### Endpoint
/v1/usages/details
```

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

### Logs API

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

Operations for querying and tailing logs.

```APIDOC
## GET /v1/streams/logs/query

### Description
Queries logs.

### Method
GET

### Endpoint
/v1/streams/logs/query

## GET /v1/streams/logs/tail

### Description
Tails logs in real-time.

### Method
GET

### Endpoint
/v1/streams/logs/tail
```

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

### Domains API

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

Operations for managing domains, including listing, creating, retrieving, deleting, and refreshing domains.

```APIDOC
## GET /v1/domains

### Description
Retrieves a list of all domains.

### Method
GET

### Endpoint
/v1/domains

## POST /v1/domains

### Description
Creates a new domain.

### Method
POST

### Endpoint
/v1/domains

## GET /v1/domains/{id}

### Description
Retrieves a specific domain by its ID.

### Method
GET

### Endpoint
/v1/domains/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the domain.

## DELETE /v1/domains/{id}

### Description
Deletes a specific domain by its ID.

### Method
DELETE

### Endpoint
/v1/domains/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the domain.

## PATCH /v1/domains/{id}

### Description
Partially updates a specific domain by its ID.

### Method
PATCH

### Endpoint
/v1/domains/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the domain.

## POST /v1/domains/{id}/refresh

### Description
Refreshes a specific domain by its ID.

### Method
POST

### Endpoint
/v1/domains/{id}/refresh

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the domain.
```

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

### PersistentVolumes API

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

Operations for managing persistent volumes, including retrieving volume events, listing volumes, creating volumes, retrieving specific volumes, deleting volumes, and updating volumes.

```APIDOC
## GET /v1/volume_events

### Description
Retrieves a list of events related to persistent volumes.

### Method
GET

### Endpoint
/v1/volume_events

## GET /v1/volumes

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

### Method
GET

### Endpoint
/v1/volumes

## POST /v1/volumes

### Description
Creates a new persistent volume.

### Method
POST

### Endpoint
/v1/volumes

## GET /v1/volumes/{id}

### Description
Retrieves a specific persistent volume by its ID.

### Method
GET

### Endpoint
/v1/volumes/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the persistent volume.

## DELETE /v1/volumes/{id}

### Description
Deletes a specific persistent volume by its ID.

### Method
DELETE

### Endpoint
/v1/volumes/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the persistent volume.

## POST /v1/volumes/{id}

### Description
Updates a specific persistent volume by its ID. Note: This endpoint seems to be incorrectly listed as POST for an update operation; typically PUT or PATCH would be used.

### Method
POST

### Endpoint
/v1/volumes/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the persistent volume.
```

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

### Snapshots API

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

Operations for managing snapshots, including listing, creating, retrieving, deleting, and updating snapshots.

```APIDOC
## GET /v1/snapshots

### Description
Retrieves a list of all snapshots.

### Method
GET

### Endpoint
/v1/snapshots

## POST /v1/snapshots

### Description
Creates a new snapshot.

### Method
POST

### Endpoint
/v1/snapshots

## GET /v1/snapshots/{id}

### Description
Retrieves a specific snapshot by its ID.

### Method
GET

### Endpoint
/v1/snapshots/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the snapshot.

## DELETE /v1/snapshots/{id}

### Description
Deletes a specific snapshot by its ID.

### Method
DELETE

### Endpoint
/v1/snapshots/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the snapshot.

## POST /v1/snapshots/{id}

### Description
Updates a specific snapshot by its ID. Note: This endpoint seems to be incorrectly listed as POST for an update operation; typically PUT or PATCH would be used.

### Method
POST

### Endpoint
/v1/snapshots/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the snapshot.
```

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

### Repositories API

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

Operations related to Git repositories, including fetching branches, listing repositories, and syncing organizations.

```APIDOC
## GET /v1/git/branches

### Description
Retrieves a list of Git branches.

### Method
GET

### Endpoint
/v1/git/branches

## GET /v1/git/repositories

### Description
Retrieves a list of Git repositories.

### Method
GET

### Endpoint
/v1/git/repositories

## POST /v1/git/sync/organization/{organization_id}

### Description
Syncs a Git repository for a specific organization.

### Method
POST

### Endpoint
/v1/git/sync/organization/{organization_id}

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The unique identifier of the organization.
```

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

### Metrics API

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

Operations for retrieving metrics.

```APIDOC
## GET /v1/streams/metrics

### Description
Retrieves metrics.

### Method
GET

### Endpoint
/v1/streams/metrics
```

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

### Archives API

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

Operations for managing archives, specifically for creating new archives.

```APIDOC
## POST /v1/archives

### Description
Creates a new archive.

### Method
POST

### Endpoint
/v1/archives
```

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

### API Error Responses

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

Standard JSON structures returned by the API when requests fail.

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

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

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

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

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

### CatalogRegions API

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

Operations for managing catalog regions, including listing and retrieving specific catalog regions.

```APIDOC
## GET /v1/catalog/regions

### Description
Retrieves a list of catalog regions.

### Method
GET

### Endpoint
/v1/catalog/regions

## GET /v1/catalog/regions/{id}

### Description
Retrieves a specific catalog region by its ID.

### Method
GET

### Endpoint
/v1/catalog/regions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the catalog region.
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.