Manage DataStax Langflow tenants

This release contains access to DataStax Langflow as a Tech Preview. The Tech Preview is intended for you to view the capabilities of DataStax Langflow, and to provide your feedback to the product team. You are permitted to use the information only for evaluation purposes and not for use in a production environment. IBM provides the information without obligation of support and "as is" without warranty of any kind.

Langflow tenants are individual Langflow instances within your DataStax organization. Each tenant represents a separate Langflow deployment with its own URL, flows, and configuration.

DataStax Langflow organizations support two distinct roles, each with specific capabilities and permissions.

For more information, see Manage roles and permissions.

Langflow Administrator role

The Langflow Administrator role provides administrative control specifically for internal Langflow management and configuration.

Capabilities

Delete Langflow IDE - can remove IDE instances.
Delete Langflow Flow - can remove flows.
Terminate Langflow Organization - can shut down Langflow organizations.
Build Langflow IDE - can create/build IDE instances.
Run Langflow Flow - can execute flows at the /run and /webhook endpoints.

To assign the Langflow Administrator role to a user, follow the steps in Edit a user’s role assignment.

Langflow DevOps API endpoints

The Langflow DevOps API provides programmatic access to manage Langflow tenants within your DataStax organization. These endpoints enable users with the Langflow Administrator role to create, monitor, and manage Langflow instances.

These endpoints require Langflow Administrator privileges.

For more information, see Use the DevOps API.

Get tenant details

Endpoint

GET /api/v1/orgs/{org_id}/tenant/{tenant_id}

Description

Retrieve a tenant by its ID for a specified organization.

Headers

Authorization: Bearer APPLICATION_TOKEN (required)
X-DataStax-Current-Org: ORG_ID (required)

Path parameters

org_id (required): DataStax organization ID
tenant_id (required): Langflow tenant ID

Request example

curl -X GET "https://api.astra.datastax.com/v1/orgs/ORG_ID/tenant/TENANT_ID" \
     -H "Authorization: Bearer APPLICATION_TOKEN" \
     -H "X-DataStax-Current-Org: ORG_ID"

List all tenants

Endpoint

GET /api/v1/orgs/{org_id}/tenants

Description

Retrieve all tenants for a specified organization.

Headers

Authorization: Bearer APPLICATION_TOKEN (required)
X-DataStax-Current-Org: ORG_ID (required)

Path parameters

org_id (required): DataStax organization ID

Request example

curl -X GET "https://api.astra.datastax.com/v1/orgs/ORG_ID/tenants" \
     -H "Authorization: Bearer APPLICATION_TOKEN" \
     -H "X-DataStax-Current-Org: ORG_ID"

Create tenant

Endpoint

POST /api/v1/tenant

Description

Create a new tenant for a specified organization.

Headers

Content-Type: application/json (required)
Authorization: Bearer APPLICATION_TOKEN (required)
X-DataStax-Current-Org: ORG_ID (required)

Request body

cloud_provider (required): Cloud provider for the tenant
org_id (required): DataStax organization ID
region (required): Deployment region

Request example

curl -X POST "https://api.astra.datastax.com/v1/tenant" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer APPLICATION_TOKEN" \
     -H "X-DataStax-Current-Org: ORG_ID" \
     -d '{
       "cloud_provider": "aws",
       "org_id": "ORG_ID",
       "region": "us-west-2"
     }'

Reactivate tenant

Endpoint

PATCH /api/v1/orgs/{org_id}/tenant/{tenant_id}/reactivate

Description

Reactivate a previously deactivated tenant for a specified organization.

Headers

Authorization: Bearer APPLICATION_TOKEN (required)
X-DataStax-Current-Org: ORG_ID (required)

Path parameters

org_id (required): DataStax organization ID
tenant_id (required): Langflow tenant ID

Request example

curl -X PATCH "https://api.astra.datastax.com/v1/orgs/ORG_ID/tenant/TENANT_ID/reactivate" \
     -H "Authorization: Bearer APPLICATION_TOKEN" \
     -H "X-DataStax-Current-Org: ORG_ID"

Langflow Run Flow role

The Langflow Run flow role allows a user or token with this role to execute flows at the /run and /webhook endpoints.

Administrators can distribute tokens with the Run Flow role to their own users for flow execution.

Capabilities

Run Langflow flow - a user or token with this role can execute flows at the /run and /webhook endpoints.

To assign the Langflow Run Flow role to a token, follow the steps in Manage application tokens.

Manage DataStax Langflow tenants

Langflow Administrator role

Langflow DevOps API endpoints

Get tenant details

List all tenants

Create tenant

Reactivate tenant

Langflow Run Flow role

Was this helpful?

Give Feedback