API Reference

Auto-generated

Integrations

API reference for integrations endpoints.

Auto-generated

This page was generated from the OpenAPI spec. Runmake generate-docs to refresh after spec changes.

PUT /api/v1/integrations/proxies/reorder

PUT

/api/v1/integrations/proxies/reorder

Batch Reorder Integrations

Parameters

Name	Type	Required	Description
integrations	`object[]`	Required	List of integrations with their new priorities

Request Example

Bash

curl -X PUT https://api.alterlab.io/api/v1/integrations/proxies/reorder \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "integrations": []
  }'

Response Example

JSON

{
  "integrations": [],
  "total": 0
}

GET /api/v1/integrations/proxies/{integration_id}

GET

/api/v1/integrations/proxies/{integration_id}

Get Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	Integration ID

Request Example

Bash

curl -X GET https://api.alterlab.io/api/v1/integrations/proxies/<integration_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "integration": "example",
  "endpoints": [],
  "available_countries": []
}

PUT /api/v1/integrations/proxies/{integration_id}

PUT

/api/v1/integrations/proxies/{integration_id}

Update Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	Integration ID
name	`string`	Optional	name
is_active	`boolean`	Optional	is_active
is_default	`boolean`	Optional	is_default
priority	`integer`	Optional	priority

Request Example

Bash

curl -X PUT https://api.alterlab.io/api/v1/integrations/proxies/<integration_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "id": "example",
  "name": "example",
  "provider": "example",
  "is_active": true,
  "is_default": true,
  "priority": 0
}

POST /api/v1/integrations/proxies/{integration_id}/refresh

POST

/api/v1/integrations/proxies/{integration_id}/refresh

Refresh Endpoints

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	Integration ID

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/integrations/proxies/<integration_id>/refresh \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "id": "example",
  "name": "example",
  "provider": "example",
  "is_active": true,
  "is_default": true,
  "priority": 0
}

POST /api/v1/integrations/proxies/{integration_id}/validate

POST

/api/v1/integrations/proxies/{integration_id}/validate

Validate Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	Integration ID

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/integrations/proxies/<integration_id>/validate \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "valid": true,
  "provider": "example",
  "account_info": "example",
  "available_products": "example",
  "error": "example"
}

GET /api/v1/integrations/storage

GET

/api/v1/integrations/storage

List Integrations

Parameters

Name	Type	Required	Description
include_inactive	`boolean`	Optional	Include disabled integrationsDefault: `False`
provider	`"s3" \| "gcs" \| "azure"`	Optional	Filter by provider

Request Example

Bash

curl -X GET https://api.alterlab.io/api/v1/integrations/storage \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "integrations": [],
  "total": 0
}

POST /api/v1/integrations/storage

POST

/api/v1/integrations/storage

Create Integration

Parameters

Name	Type	Required	Description
name	`string`	Required	Friendly name (e.g., 'My S3 Bucket')
provider	`"s3" \| "gcs" \| "azure"`	Required	Supported cloud storage providers.
credentials	`object`	Required	Provider-specific credentials
bucket	`string`	Required	Bucket or container name
region	`string`	Optional	region
prefix	`string`	Optional	Default key prefix for uploads
is_default	`boolean`	Optional	Set as default export destinationDefault: `False`

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/integrations/storage \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "example_name",
    "provider": "...",
    "credentials": "...",
    "bucket": "example_bucket"
  }'

Response Example

JSON

{
  "status": "ok"
}

GET /api/v1/integrations/storage/providers

GET

/api/v1/integrations/storage/providers

List Providers

Request Example

Bash

curl -X GET https://api.alterlab.io/api/v1/integrations/storage/providers \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "status": "ok"
}

GET /api/v1/integrations/storage/{integration_id}

GET

/api/v1/integrations/storage/{integration_id}

Get Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id

Request Example

Bash

curl -X GET https://api.alterlab.io/api/v1/integrations/storage/<integration_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "id": "example",
  "name": "example",
  "provider": "example",
  "bucket": "example",
  "region": "example",
  "prefix": "example"
}

PUT /api/v1/integrations/storage/{integration_id}

PUT

/api/v1/integrations/storage/{integration_id}

Update Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id
name	`string`	Optional	name
bucket	`string`	Optional	bucket
region	`string`	Optional	region
prefix	`string`	Optional	prefix
is_active	`boolean`	Optional	is_active
is_default	`boolean`	Optional	is_default

Request Example

Bash

curl -X PUT https://api.alterlab.io/api/v1/integrations/storage/<integration_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "id": "example",
  "name": "example",
  "provider": "example",
  "bucket": "example",
  "region": "example",
  "prefix": "example"
}

DELETE /api/v1/integrations/storage/{integration_id}

DELETE

/api/v1/integrations/storage/{integration_id}

Delete Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id

Request Example

Bash

curl -X DELETE https://api.alterlab.io/api/v1/integrations/storage/<integration_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "status": "ok"
}

PUT /api/v1/integrations/storage/{integration_id}/credentials

PUT

/api/v1/integrations/storage/{integration_id}/credentials

Update Credentials

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id
credentials	`object`	Required	New provider-specific credentials

Request Example

Bash

curl -X PUT https://api.alterlab.io/api/v1/integrations/storage/<integration_id>/credentials \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "credentials": "..."
  }'

Response Example

JSON

{
  "id": "example",
  "name": "example",
  "provider": "example",
  "bucket": "example",
  "region": "example",
  "prefix": "example"
}

PUT /api/v1/integrations/storage/{integration_id}/default

PUT

/api/v1/integrations/storage/{integration_id}/default

Set Default Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id

Request Example

Bash

curl -X PUT https://api.alterlab.io/api/v1/integrations/storage/<integration_id>/default \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "id": "example",
  "name": "example",
  "provider": "example",
  "bucket": "example",
  "region": "example",
  "prefix": "example"
}

POST /api/v1/integrations/storage/{integration_id}/test

POST

/api/v1/integrations/storage/{integration_id}/test

Test Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/integrations/storage/<integration_id>/test \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "success": true,
  "message": "example",
  "error": "example"
}

POST /api/v1/integrations/storage/{integration_id}/validate

POST

/api/v1/integrations/storage/{integration_id}/validate

Validate Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/integrations/storage/<integration_id>/validate \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "valid": true,
  "provider": "example",
  "bucket_exists": true,
  "writable": true,
  "error": "example"
}

Last updated: March 2026

API Reference

Auto-generated

Integrations

API reference for integrations endpoints.

Auto-generated

This page was generated from the OpenAPI spec. Runmake generate-docs to refresh after spec changes.

PUT /api/v1/integrations/proxies/reorder

PUT

/api/v1/integrations/proxies/reorder

Batch Reorder Integrations

Parameters

Name	Type	Required	Description
integrations	`object[]`	Required	List of integrations with their new priorities

Request Example

Bash

curl -X PUT https://api.alterlab.io/api/v1/integrations/proxies/reorder \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "integrations": []
  }'

Response Example

JSON

{
  "integrations": [],
  "total": 0
}

GET /api/v1/integrations/proxies/{integration_id}

GET

/api/v1/integrations/proxies/{integration_id}

Get Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	Integration ID

Request Example

Bash

curl -X GET https://api.alterlab.io/api/v1/integrations/proxies/<integration_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "integration": "example",
  "endpoints": [],
  "available_countries": []
}

PUT /api/v1/integrations/proxies/{integration_id}

PUT

/api/v1/integrations/proxies/{integration_id}

Update Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	Integration ID
name	`string`	Optional	name
is_active	`boolean`	Optional	is_active
is_default	`boolean`	Optional	is_default
priority	`integer`	Optional	priority

Request Example

Bash

curl -X PUT https://api.alterlab.io/api/v1/integrations/proxies/<integration_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "id": "example",
  "name": "example",
  "provider": "example",
  "is_active": true,
  "is_default": true,
  "priority": 0
}

POST /api/v1/integrations/proxies/{integration_id}/refresh

POST

/api/v1/integrations/proxies/{integration_id}/refresh

Refresh Endpoints

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	Integration ID

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/integrations/proxies/<integration_id>/refresh \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "id": "example",
  "name": "example",
  "provider": "example",
  "is_active": true,
  "is_default": true,
  "priority": 0
}

POST /api/v1/integrations/proxies/{integration_id}/validate

POST

/api/v1/integrations/proxies/{integration_id}/validate

Validate Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	Integration ID

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/integrations/proxies/<integration_id>/validate \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "valid": true,
  "provider": "example",
  "account_info": "example",
  "available_products": "example",
  "error": "example"
}

GET /api/v1/integrations/storage

GET

/api/v1/integrations/storage

List Integrations

Parameters

Name	Type	Required	Description
include_inactive	`boolean`	Optional	Include disabled integrationsDefault: `False`
provider	`"s3" \| "gcs" \| "azure"`	Optional	Filter by provider

Request Example

Bash

curl -X GET https://api.alterlab.io/api/v1/integrations/storage \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "integrations": [],
  "total": 0
}

POST /api/v1/integrations/storage

POST

/api/v1/integrations/storage

Create Integration

Parameters

Name	Type	Required	Description
name	`string`	Required	Friendly name (e.g., 'My S3 Bucket')
provider	`"s3" \| "gcs" \| "azure"`	Required	Supported cloud storage providers.
credentials	`object`	Required	Provider-specific credentials
bucket	`string`	Required	Bucket or container name
region	`string`	Optional	region
prefix	`string`	Optional	Default key prefix for uploads
is_default	`boolean`	Optional	Set as default export destinationDefault: `False`

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/integrations/storage \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "example_name",
    "provider": "...",
    "credentials": "...",
    "bucket": "example_bucket"
  }'

Response Example

JSON

{
  "status": "ok"
}

GET /api/v1/integrations/storage/providers

GET

/api/v1/integrations/storage/providers

List Providers

Request Example

Bash

curl -X GET https://api.alterlab.io/api/v1/integrations/storage/providers \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "status": "ok"
}

GET /api/v1/integrations/storage/{integration_id}

GET

/api/v1/integrations/storage/{integration_id}

Get Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id

Request Example

Bash

curl -X GET https://api.alterlab.io/api/v1/integrations/storage/<integration_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "id": "example",
  "name": "example",
  "provider": "example",
  "bucket": "example",
  "region": "example",
  "prefix": "example"
}

PUT /api/v1/integrations/storage/{integration_id}

PUT

/api/v1/integrations/storage/{integration_id}

Update Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id
name	`string`	Optional	name
bucket	`string`	Optional	bucket
region	`string`	Optional	region
prefix	`string`	Optional	prefix
is_active	`boolean`	Optional	is_active
is_default	`boolean`	Optional	is_default

Request Example

Bash

curl -X PUT https://api.alterlab.io/api/v1/integrations/storage/<integration_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "id": "example",
  "name": "example",
  "provider": "example",
  "bucket": "example",
  "region": "example",
  "prefix": "example"
}

DELETE /api/v1/integrations/storage/{integration_id}

DELETE

/api/v1/integrations/storage/{integration_id}

Delete Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id

Request Example

Bash

curl -X DELETE https://api.alterlab.io/api/v1/integrations/storage/<integration_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "status": "ok"
}

PUT /api/v1/integrations/storage/{integration_id}/credentials

PUT

/api/v1/integrations/storage/{integration_id}/credentials

Update Credentials

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id
credentials	`object`	Required	New provider-specific credentials

Request Example

Bash

curl -X PUT https://api.alterlab.io/api/v1/integrations/storage/<integration_id>/credentials \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "credentials": "..."
  }'

Response Example

JSON

{
  "id": "example",
  "name": "example",
  "provider": "example",
  "bucket": "example",
  "region": "example",
  "prefix": "example"
}

PUT /api/v1/integrations/storage/{integration_id}/default

PUT

/api/v1/integrations/storage/{integration_id}/default

Set Default Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id

Request Example

Bash

curl -X PUT https://api.alterlab.io/api/v1/integrations/storage/<integration_id>/default \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "id": "example",
  "name": "example",
  "provider": "example",
  "bucket": "example",
  "region": "example",
  "prefix": "example"
}

POST /api/v1/integrations/storage/{integration_id}/test

POST

/api/v1/integrations/storage/{integration_id}/test

Test Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/integrations/storage/<integration_id>/test \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "success": true,
  "message": "example",
  "error": "example"
}

POST /api/v1/integrations/storage/{integration_id}/validate

POST

/api/v1/integrations/storage/{integration_id}/validate

Validate Integration

Parameters

Name	Type	Required	Description
integration_id	`string`	Required	integration_id

Request Example

Bash

curl -X POST https://api.alterlab.io/api/v1/integrations/storage/<integration_id>/validate \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Example

JSON

{
  "valid": true,
  "provider": "example",
  "bucket_exists": true,
  "writable": true,
  "error": "example"
}

Last updated: March 2026