FastAPI 0.1.0
Servers
| Description | URL |
|---|---|
| /api | /api |
users
GET /users
Users:List Users
Description
Get all users.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
page |
query | integer | 1 | No | |
size |
query | integer | 50 | No |
Response 200 OK
{
"items": [
{
"id": "e550f325-1c80-4d32-98c0-444075684295",
"email": "[email protected]",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"active_env_id": null
}
],
"total": null,
"page": null,
"size": null,
"pages": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/UserRead"
},
"type": "array",
"title": "Items"
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Total"
},
"page": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Page"
},
"size": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Size"
},
"pages": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size"
],
"title": "Page[UserRead]"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /users/me/change-password
Users:Change Password
Description
Change the current user's password.
Args: password_data: Password change data user: Current authenticated user
Returns: Updated user information
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"old_password": "string",
"new_password": "string"
}
Schema of the request body
{
"properties": {
"old_password": {
"type": "string",
"title": "Old Password"
},
"new_password": {
"type": "string",
"title": "New Password"
}
},
"type": "object",
"required": [
"old_password",
"new_password"
],
"title": "UserPasswordChange",
"description": "Change user password."
}
Response 200 OK
{
"id": "f1425591-b9a8-45b7-a021-306fb95d0d1e",
"email": "[email protected]",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"active_env_id": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"email": {
"type": "string",
"format": "email",
"title": "Email"
},
"is_active": {
"type": "boolean",
"title": "Is Active",
"default": true
},
"is_superuser": {
"type": "boolean",
"title": "Is Superuser",
"default": false
},
"is_verified": {
"type": "boolean",
"title": "Is Verified",
"default": false
},
"active_env_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Env Id"
}
},
"type": "object",
"required": [
"id",
"email",
"active_env_id"
],
"title": "UserRead",
"description": "Read a user."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /users/export-all
Export all users, envs, teams, and their relations
Description
Export all users, environments, teams, and their relationships as a structured data object. Requires admin privileges.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
{
"users": [
{
"id": "b8dd0613-169a-45cb-b2c0-30436c6725b7",
"email": "[email protected]",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"active_env_id": null
}
],
"envs": [
{
"name": "string",
"use_retention": true,
"retention_configuration": null,
"id": "57470609-8e20-4d36-b1af-7278ca8af7b1"
}
],
"teams": [
{
"name": "string",
"description": "string",
"env_id": null,
"id": "cbf64950-c8e3-4e6e-aef5-92b8adcb0088"
}
],
"env_members": [
{
"user_id": "6caeba95-c2cf-4db6-94b4-32cff42f477d",
"env_id": "28e8318e-f85c-43c3-8c13-c4fb45ded7f8",
"admin": true
}
],
"team_members": [
{
"user_id": "51c7311e-cdb6-4826-8097-ea62529ef41e",
"team_id": "bafd7032-7795-4898-a413-9b399fac7820",
"admin": true
}
]
}
Schema of the response body
{
"properties": {
"users": {
"items": {
"$ref": "#/components/schemas/UserExport"
},
"type": "array",
"title": "Users",
"description": "List of all users in the system"
},
"envs": {
"items": {
"$ref": "#/components/schemas/EnvExport"
},
"type": "array",
"title": "Envs",
"description": "List of all environments in the system"
},
"teams": {
"items": {
"$ref": "#/components/schemas/TeamExport"
},
"type": "array",
"title": "Teams",
"description": "List of all teams in the system"
},
"env_members": {
"items": {
"$ref": "#/components/schemas/EnvMemberExport"
},
"type": "array",
"title": "Env Members",
"description": "List of all user-environment membership relationships"
},
"team_members": {
"items": {
"$ref": "#/components/schemas/TeamMemberExport"
},
"type": "array",
"title": "Team Members",
"description": "List of all user-team membership relationships"
}
},
"type": "object",
"required": [
"users",
"envs",
"teams",
"env_members",
"team_members"
],
"title": "ExportData",
"description": "Complete data export model containing all system entities and their relationships."
}
POST /users/import-all
Import all users, envs, teams, and their relations
Description
Import all users, environments, teams, and their relationships from a structured data object. Requires admin privileges. This will overwrite all existing data.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"users": [
{
"id": "6a2525c9-9da1-4ecf-9902-1c8fa03ffd73",
"email": "[email protected]",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"active_env_id": null
}
],
"envs": [
{
"name": "string",
"use_retention": true,
"retention_configuration": null,
"id": "7e48b167-be9b-4a7c-af95-d1e338d1c96f"
}
],
"teams": [
{
"name": "string",
"description": "string",
"env_id": null,
"id": "be905d8d-92c6-4bb5-ba64-5ecf2c29a02b"
}
],
"env_members": [
{
"user_id": "8723ce3d-cc98-438f-bb33-a1a3f746a27e",
"env_id": "067948f5-9d78-4333-8375-abb87ea98482",
"admin": true
}
],
"team_members": [
{
"user_id": "7f892db7-243d-47d1-9bf7-3eea836919ef",
"team_id": "97a468b1-1fcf-4481-8bab-bf361a5a38d1",
"admin": true
}
]
}
Schema of the request body
{
"properties": {
"users": {
"items": {
"$ref": "#/components/schemas/UserExport"
},
"type": "array",
"title": "Users",
"description": "List of all users in the system"
},
"envs": {
"items": {
"$ref": "#/components/schemas/EnvExport"
},
"type": "array",
"title": "Envs",
"description": "List of all environments in the system"
},
"teams": {
"items": {
"$ref": "#/components/schemas/TeamExport"
},
"type": "array",
"title": "Teams",
"description": "List of all teams in the system"
},
"env_members": {
"items": {
"$ref": "#/components/schemas/EnvMemberExport"
},
"type": "array",
"title": "Env Members",
"description": "List of all user-environment membership relationships"
},
"team_members": {
"items": {
"$ref": "#/components/schemas/TeamMemberExport"
},
"type": "array",
"title": "Team Members",
"description": "List of all user-team membership relationships"
}
},
"type": "object",
"required": [
"users",
"envs",
"teams",
"env_members",
"team_members"
],
"title": "ExportData",
"description": "Complete data export model containing all system entities and their relationships."
}
Response 204 No Content
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /users/me
Users:Current User
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
{
"id": "fb9def11-6f11-4732-9732-2a41ede8ddac",
"email": "[email protected]",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"active_env_id": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"email": {
"type": "string",
"format": "email",
"title": "Email"
},
"is_active": {
"type": "boolean",
"title": "Is Active",
"default": true
},
"is_superuser": {
"type": "boolean",
"title": "Is Superuser",
"default": false
},
"is_verified": {
"type": "boolean",
"title": "Is Verified",
"default": false
},
"active_env_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Env Id"
}
},
"type": "object",
"required": [
"id",
"email",
"active_env_id"
],
"title": "UserRead",
"description": "Read a user."
}
Response 401 Unauthorized
PATCH /users/me
Users:Patch Current User
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"password": null,
"email": null,
"is_active": null,
"is_superuser": null,
"is_verified": null,
"active_env_id": null
}
Schema of the request body
{
"properties": {
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Password"
},
"email": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Email"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"is_superuser": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Superuser"
},
"is_verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Verified"
},
"active_env_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Env Id"
}
},
"type": "object",
"title": "UserSafeUpdate",
"description": "Update a user without password."
}
Response 200 OK
{
"id": "0bcd2bd3-0325-4a61-9bed-f13bffbde5c6",
"email": "[email protected]",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"active_env_id": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"email": {
"type": "string",
"format": "email",
"title": "Email"
},
"is_active": {
"type": "boolean",
"title": "Is Active",
"default": true
},
"is_superuser": {
"type": "boolean",
"title": "Is Superuser",
"default": false
},
"is_verified": {
"type": "boolean",
"title": "Is Verified",
"default": false
},
"active_env_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Env Id"
}
},
"type": "object",
"required": [
"id",
"email",
"active_env_id"
],
"title": "UserRead",
"description": "Read a user."
}
Response 401 Unauthorized
Response 400 Bad Request
{
"detail": "UPDATE_USER_EMAIL_ALREADY_EXISTS"
}
{
"detail": {
"code": "UPDATE_USER_INVALID_PASSWORD",
"reason": "Password should beat least 3 characters"
}
}
Schema of the response body
{
"properties": {
"detail": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
],
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorModel"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /users/{id}
Users:User
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
id |
path | string | No |
Response 200 OK
{
"id": "e8f31c5d-1ff2-4713-baed-ef228271cf31",
"email": "[email protected]",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"active_env_id": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"email": {
"type": "string",
"format": "email",
"title": "Email"
},
"is_active": {
"type": "boolean",
"title": "Is Active",
"default": true
},
"is_superuser": {
"type": "boolean",
"title": "Is Superuser",
"default": false
},
"is_verified": {
"type": "boolean",
"title": "Is Verified",
"default": false
},
"active_env_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Env Id"
}
},
"type": "object",
"required": [
"id",
"email",
"active_env_id"
],
"title": "UserRead",
"description": "Read a user."
}
Response 401 Unauthorized
Response 403 Forbidden
Response 404 Not Found
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /users/{id}
Users:Patch User
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
id |
path | string | No |
Request body
{
"password": null,
"email": null,
"is_active": null,
"is_superuser": null,
"is_verified": null,
"active_env_id": null
}
Schema of the request body
{
"properties": {
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Password"
},
"email": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Email"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"is_superuser": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Superuser"
},
"is_verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Verified"
},
"active_env_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Env Id"
}
},
"type": "object",
"title": "UserSafeUpdate",
"description": "Update a user without password."
}
Response 200 OK
{
"id": "12eb4918-a9b3-4948-82f2-8ff9d233094d",
"email": "[email protected]",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"active_env_id": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"email": {
"type": "string",
"format": "email",
"title": "Email"
},
"is_active": {
"type": "boolean",
"title": "Is Active",
"default": true
},
"is_superuser": {
"type": "boolean",
"title": "Is Superuser",
"default": false
},
"is_verified": {
"type": "boolean",
"title": "Is Verified",
"default": false
},
"active_env_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Env Id"
}
},
"type": "object",
"required": [
"id",
"email",
"active_env_id"
],
"title": "UserRead",
"description": "Read a user."
}
Response 401 Unauthorized
Response 403 Forbidden
Response 404 Not Found
Response 400 Bad Request
{
"detail": "UPDATE_USER_EMAIL_ALREADY_EXISTS"
}
{
"detail": {
"code": "UPDATE_USER_INVALID_PASSWORD",
"reason": "Password should beat least 3 characters"
}
}
Schema of the response body
{
"properties": {
"detail": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
],
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorModel"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /users/{id}
Users:Delete User
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
id |
path | string | No |
Response 204 No Content
Response 401 Unauthorized
Response 403 Forbidden
Response 404 Not Found
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
auth
POST /auth/jwt/login
Auth:Jwt.Login
Request body
{
"grant_type": null,
"username": "string",
"password": "string",
"scope": "string",
"client_id": null,
"client_secret": null
}
Schema of the request body
{
"properties": {
"grant_type": {
"anyOf": [
{
"type": "string",
"pattern": "^password$"
},
{
"type": "null"
}
],
"title": "Grant Type"
},
"username": {
"type": "string",
"title": "Username"
},
"password": {
"type": "string",
"title": "Password"
},
"scope": {
"type": "string",
"title": "Scope",
"default": ""
},
"client_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Client Id"
},
"client_secret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Client Secret"
}
},
"type": "object",
"required": [
"username",
"password"
],
"title": "Body_auth_jwt_login_auth_jwt_login_post"
}
Response 200 OK
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOTIyMWZmYzktNjQwZi00MzcyLTg2ZDMtY2U2NDJjYmE1NjAzIiwiYXVkIjoiZmFzdGFwaS11c2VyczphdXRoIiwiZXhwIjoxNTcxNTA0MTkzfQ.M10bjOe45I5Ncu_uXvOmVV8QxnL-nZfcH96U90JaocI",
"token_type": "bearer"
}
Schema of the response body
{
"properties": {
"access_token": {
"type": "string",
"title": "Access Token"
},
"token_type": {
"type": "string",
"title": "Token Type"
}
},
"type": "object",
"required": [
"access_token",
"token_type"
],
"title": "BearerResponse"
}
Response 400 Bad Request
{
"detail": "LOGIN_BAD_CREDENTIALS"
}
{
"detail": "LOGIN_USER_NOT_VERIFIED"
}
Schema of the response body
{
"properties": {
"detail": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
],
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorModel"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /auth/jwt/logout
Auth:Jwt.Logout
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
Schema of the response body
Response 401 Unauthorized
POST /auth/register
Register:Register
Request body
{
"email": "[email protected]",
"password": "string",
"is_active": null,
"is_superuser": true,
"is_verified": null
}
Schema of the request body
{
"properties": {
"email": {
"type": "string",
"format": "email",
"title": "Email"
},
"password": {
"type": "string",
"title": "Password"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active",
"default": true
},
"is_superuser": {
"type": "boolean",
"title": "Is Superuser",
"default": false
},
"is_verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Verified",
"default": false
}
},
"type": "object",
"required": [
"email",
"password"
],
"title": "UserCreate",
"description": "Create a user."
}
Response 201 Created
{
"id": "3dff26fb-8bec-4f7a-8ccb-9710dcd7eb0a",
"email": "[email protected]",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"active_env_id": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"email": {
"type": "string",
"format": "email",
"title": "Email"
},
"is_active": {
"type": "boolean",
"title": "Is Active",
"default": true
},
"is_superuser": {
"type": "boolean",
"title": "Is Superuser",
"default": false
},
"is_verified": {
"type": "boolean",
"title": "Is Verified",
"default": false
},
"active_env_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Env Id"
}
},
"type": "object",
"required": [
"id",
"email",
"active_env_id"
],
"title": "UserRead",
"description": "Read a user."
}
Response 400 Bad Request
{
"detail": "REGISTER_USER_ALREADY_EXISTS"
}
{
"detail": {
"code": "REGISTER_INVALID_PASSWORD",
"reason": "Password should beat least 3 characters"
}
}
Schema of the response body
{
"properties": {
"detail": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
],
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorModel"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /auth/forgot-password
Reset:Forgot Password
Request body
{
"email": "[email protected]"
}
Schema of the request body
{
"properties": {
"email": {
"type": "string",
"format": "email",
"title": "Email"
}
},
"type": "object",
"required": [
"email"
],
"title": "Body_reset_forgot_password_auth_forgot_password_post"
}
Response 202 Accepted
Schema of the response body
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /auth/reset-password
Reset:Reset Password
Request body
{
"token": "string",
"password": "string"
}
Schema of the request body
{
"properties": {
"token": {
"type": "string",
"title": "Token"
},
"password": {
"type": "string",
"title": "Password"
}
},
"type": "object",
"required": [
"token",
"password"
],
"title": "Body_reset_reset_password_auth_reset_password_post"
}
Response 200 OK
Schema of the response body
Response 400 Bad Request
{
"detail": "RESET_PASSWORD_BAD_TOKEN"
}
{
"detail": {
"code": "RESET_PASSWORD_INVALID_PASSWORD",
"reason": "Password should be at least 3 characters"
}
}
Schema of the response body
{
"properties": {
"detail": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
],
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorModel"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /auth/request-verify-token
Verify:Request-Token
Request body
{
"email": "[email protected]"
}
Schema of the request body
{
"properties": {
"email": {
"type": "string",
"format": "email",
"title": "Email"
}
},
"type": "object",
"required": [
"email"
],
"title": "Body_verify_request_token_auth_request_verify_token_post"
}
Response 202 Accepted
Schema of the response body
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /auth/verify
Verify:Verify
Request body
{
"token": "string"
}
Schema of the request body
{
"properties": {
"token": {
"type": "string",
"title": "Token"
}
},
"type": "object",
"required": [
"token"
],
"title": "Body_verify_verify_auth_verify_post"
}
Response 200 OK
{
"id": "be8ced70-1f4e-4001-81cf-e9d8f7c32b10",
"email": "[email protected]",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"active_env_id": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"email": {
"type": "string",
"format": "email",
"title": "Email"
},
"is_active": {
"type": "boolean",
"title": "Is Active",
"default": true
},
"is_superuser": {
"type": "boolean",
"title": "Is Superuser",
"default": false
},
"is_verified": {
"type": "boolean",
"title": "Is Verified",
"default": false
},
"active_env_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Env Id"
}
},
"type": "object",
"required": [
"id",
"email",
"active_env_id"
],
"title": "UserRead",
"description": "Read a user."
}
Response 400 Bad Request
{
"detail": "VERIFY_USER_BAD_TOKEN"
}
{
"detail": "VERIFY_USER_ALREADY_VERIFIED"
}
Schema of the response body
{
"properties": {
"detail": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
],
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ErrorModel"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
healthchecks
GET /healthchecks
Healthchecks:Api
Description
Get the status of the api.
Response 200 OK
{
"status": "string"
}
Schema of the response body
{
"properties": {
"status": {
"type": "string",
"title": "Status"
}
},
"type": "object",
"required": [
"status"
],
"title": "HealthCheck",
"description": "Healthcheck pydantic model."
}
GET /healthchecks/k8s
Healthchecks:K8S
Description
Get the status of kubernetes.
Response 200 OK
{
"status": "string"
}
Schema of the response body
{
"properties": {
"status": {
"type": "string",
"title": "Status"
}
},
"type": "object",
"required": [
"status"
],
"title": "HealthCheck",
"description": "Healthcheck pydantic model."
}
GET /healthchecks/db
Healthchecks:Db
Description
Get the status of the database.
Response 200 OK
{
"status": "string"
}
Schema of the response body
{
"properties": {
"status": {
"type": "string",
"title": "Status"
}
},
"type": "object",
"required": [
"status"
],
"title": "HealthCheck",
"description": "Healthcheck pydantic model."
}
GET /healthchecks/debug
Healthchecks:Debug
Description
Display debugs infos.
Response 200 OK
{
"header": {}
}
Schema of the response body
{
"properties": {
"header": {
"type": "object",
"title": "Header"
}
},
"type": "object",
"required": [
"header"
],
"title": "Debug",
"description": "Debug model."
}
probes
GET /livez
Probes:Livez
Description
Get the liveness probe.
Response 200 OK
{
"status": "string"
}
Schema of the response body
{
"properties": {
"status": {
"type": "string",
"title": "Status"
}
},
"type": "object",
"required": [
"status"
],
"title": "HealthCheck",
"description": "Healthcheck pydantic model."
}
GET /readyz
Probes:Livez
Description
Get the readiness probe.
Response 200 OK
{
"status": "string"
}
Schema of the response body
{
"properties": {
"status": {
"type": "string",
"title": "Status"
}
},
"type": "object",
"required": [
"status"
],
"title": "HealthCheck",
"description": "Healthcheck pydantic model."
}
schemas
POST /schemas/{subject}
Schemas:Register
Description
Register a schema.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
subject |
path | string | No |
Request body
{
"schema": "string"
}
Schema of the request body
{
"properties": {
"schema": {
"type": "string",
"title": "Schema",
"description": "The raw schema definition, typically in Avro or JSON Schema format.",
"examples": [
"{'type': 'record', 'name': 'User', 'fields': [{'name': 'id', 'type': 'string'}]}"
]
}
},
"type": "object",
"required": [
"schema"
],
"title": "SchemaCreate",
"description": "Serializer for creating a new schema.\n\nAttributes:\n schema_content (str): The raw content of the schema (e.g., Avro, JSON Schema)."
}
Response 201 Created
{
"id": "0d49b5b3-bf45-4983-acbf-88a886bf2517",
"version": 0
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier of the schema."
},
"version": {
"type": "integer",
"title": "Version",
"description": "Version of the schema."
}
},
"type": "object",
"required": [
"id",
"version"
],
"title": "SchemaRead",
"description": "Serializer for reading a schema record.\n\nAttributes:\n id (UUID): Unique identifier of the schema.\n version (int): Schema version number."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
pipelines
GET /pipelines/
List pipelines
Description
Retrieve a paginated list of pipelines with optional filters for state, search keyword, and team.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
page |
query | integer | 1 | No | |
search |
query | None | No | Search term to filter pipelines by name or description. | |
size |
query | integer | 50 | No | |
state |
query | None | No | Filter pipelines by state (e.g., BUILDING, PAUSED). | |
team_id |
query | None | No | Filter pipelines by the ID of the team they belong to. |
Response 200 OK
{
"items": [
{
"id": "c5f106fa-9a39-4858-a3ea-dc74330fe708",
"source_name": "string",
"source_type": null,
"transform": 0,
"target_name": "string",
"target_type": null,
"name": "string",
"state": "draft",
"owner": "string"
}
],
"total": null,
"page": null,
"size": null,
"pages": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/PipelineList"
},
"type": "array",
"title": "Items"
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Total"
},
"page": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Page"
},
"size": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Size"
},
"pages": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size"
],
"title": "Page[PipelineList]"
}
Response 403 Forbidden
{
"detail": "Unauthorized."
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ResponseModel403",
"description": "Response model for 403 Forbidden."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /pipelines/
Create a new pipeline
Description
Register a new pipeline in the system, requires write permissions on the team.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"name": "string",
"team_id": "7dfc8166-b303-4f1a-a69e-023d14dd2b4a",
"state": "draft",
"json_configuration": {
"source_name": "postgres-source",
"source_type": null,
"source_config": {},
"target_name": "kafka-target",
"target_type": null,
"target_config": {},
"smt_name": "string",
"smt_config": [
null
],
"draft_step": "string"
}
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the pipeline",
"examples": [
"data-ingest-pipeline"
]
},
"team_id": {
"type": "string",
"format": "uuid",
"title": "Team Id",
"description": "ID of the team that owns the pipeline"
},
"state": {
"$ref": "#/components/schemas/PipelineState",
"description": "Current state of the pipeline"
},
"json_configuration": {
"$ref": "#/components/schemas/PipelineConfigAsSerializer-Input",
"description": "Complete configuration of the pipeline"
}
},
"type": "object",
"required": [
"name",
"team_id",
"state",
"json_configuration"
],
"title": "PipelineCreate",
"description": "Request model for creating a new pipeline."
}
Response 201 Created
{
"name": "string",
"state": "draft",
"json_configuration": {
"source_name": "postgres-source",
"source_type": null,
"source_config": {},
"target_name": "kafka-target",
"target_type": null,
"target_config": {},
"smt_name": "string",
"smt_config": [
null
],
"draft_step": "string"
},
"id": "18186b11-bd05-48e5-b6f4-eccd0395a803",
"team_name": "string",
"team_id": "90051376-e89d-4dbc-be2d-3391ed56733b"
}
Schema of the response body
{
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the pipeline"
},
"state": {
"$ref": "#/components/schemas/PipelineState",
"description": "Current state of the pipeline"
},
"json_configuration": {
"$ref": "#/components/schemas/PipelineConfigAsSerializer-Output",
"description": "Pipeline configuration structure"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier of the pipeline"
},
"team_name": {
"type": "string",
"title": "Team Name",
"description": "Name of the team that owns the pipeline"
},
"team_id": {
"type": "string",
"format": "uuid",
"title": "Team Id",
"description": "UUID of the owning team"
}
},
"type": "object",
"required": [
"name",
"state",
"json_configuration",
"id",
"team_name",
"team_id"
],
"title": "PipelineRead",
"description": "Response model for reading a pipeline's details."
}
Response 403 Forbidden
{
"detail": "Unauthorized."
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ResponseModel403",
"description": "Response model for 403 Forbidden."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /pipelines/count-status
Count pipelines by status
Description
Return the number of pipelines grouped by their state in the current environment.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
{
"all": 0,
"draft": 0,
"live": 0,
"paused": 0,
"error": 0,
"building": 0
}
Schema of the response body
{
"properties": {
"all": {
"type": "integer",
"title": "All",
"description": "Total number of pipelines",
"default": 0
},
"draft": {
"type": "integer",
"title": "Draft",
"description": "Number of pipelines in draft state",
"default": 0
},
"live": {
"type": "integer",
"title": "Live",
"description": "Number of active (live) pipelines",
"default": 0
},
"paused": {
"type": "integer",
"title": "Paused",
"description": "Number of paused pipelines",
"default": 0
},
"error": {
"type": "integer",
"title": "Error",
"description": "Number of pipelines with errors",
"default": 0
},
"building": {
"type": "integer",
"title": "Building",
"description": "Number of pipelines being built",
"default": 0
}
},
"type": "object",
"title": "PipelinesStatusCounter",
"description": "Counts of pipelines by their status."
}
Response 403 Forbidden
{
"detail": "Unauthorized."
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ResponseModel403",
"description": "Response model for 403 Forbidden."
}
PATCH /pipelines/{pipeline_id}
Update a pipeline
Description
Update properties of an existing pipeline, requires write permission on the pipeline.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
pipeline_id |
path | string | No | UUID of the pipeline to update |
Request body
{
"name": null,
"team_id": null,
"state": null,
"json_configuration": null
}
Schema of the request body
{
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "Updated name of the pipeline"
},
"team_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Team Id",
"description": "Updated team ID"
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/PipelineState"
},
{
"type": "null"
}
],
"description": "Updated pipeline state"
},
"json_configuration": {
"anyOf": [
{
"$ref": "#/components/schemas/PipelineConfigAsSerializer-Input"
},
{
"type": "null"
}
],
"description": "Updated configuration"
}
},
"type": "object",
"title": "PipelineUpdate",
"description": "Request model for updating an existing pipeline."
}
Response 200 OK
{
"name": "string",
"state": "draft",
"json_configuration": {
"source_name": "postgres-source",
"source_type": null,
"source_config": {},
"target_name": "kafka-target",
"target_type": null,
"target_config": {},
"smt_name": "string",
"smt_config": [
null
],
"draft_step": "string"
},
"id": "84eb90cc-9e76-4564-ab41-eb9659bc5d99",
"team_name": "string",
"team_id": "4da12a7a-3d53-4052-8ce6-1b11d35db279"
}
Schema of the response body
{
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the pipeline"
},
"state": {
"$ref": "#/components/schemas/PipelineState",
"description": "Current state of the pipeline"
},
"json_configuration": {
"$ref": "#/components/schemas/PipelineConfigAsSerializer-Output",
"description": "Pipeline configuration structure"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier of the pipeline"
},
"team_name": {
"type": "string",
"title": "Team Name",
"description": "Name of the team that owns the pipeline"
},
"team_id": {
"type": "string",
"format": "uuid",
"title": "Team Id",
"description": "UUID of the owning team"
}
},
"type": "object",
"required": [
"name",
"state",
"json_configuration",
"id",
"team_name",
"team_id"
],
"title": "PipelineRead",
"description": "Response model for reading a pipeline's details."
}
Response 403 Forbidden
{
"detail": "Unauthorized."
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ResponseModel403",
"description": "Response model for 403 Forbidden."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /pipelines/{pipeline_id}
Delete a pipeline
Description
Delete the specified pipeline, requires delete permission.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
pipeline_id |
path | string | No | UUID of the pipeline to delete |
Response 204 No Content
Response 403 Forbidden
{
"detail": "Unauthorized."
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ResponseModel403",
"description": "Response model for 403 Forbidden."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /pipelines/{pipeline_id}
Get pipeline details
Description
Retrieve detailed information of a pipeline by its ID.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
pipeline_id |
path | string | No | UUID of the pipeline to get |
Response 200 OK
{
"name": "string",
"state": "draft",
"json_configuration": {
"source_name": "postgres-source",
"source_type": null,
"source_config": {},
"target_name": "kafka-target",
"target_type": null,
"target_config": {},
"smt_name": "string",
"smt_config": [
null
],
"draft_step": "string"
},
"id": "fbd80a2e-3439-4a31-a8e4-7eb250944619",
"team_name": "string",
"team_id": "ddc2dba5-6ef0-4fa7-b655-035b4b0e5755"
}
Schema of the response body
{
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the pipeline"
},
"state": {
"$ref": "#/components/schemas/PipelineState",
"description": "Current state of the pipeline"
},
"json_configuration": {
"$ref": "#/components/schemas/PipelineConfigAsSerializer-Output",
"description": "Pipeline configuration structure"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier of the pipeline"
},
"team_name": {
"type": "string",
"title": "Team Name",
"description": "Name of the team that owns the pipeline"
},
"team_id": {
"type": "string",
"format": "uuid",
"title": "Team Id",
"description": "UUID of the owning team"
}
},
"type": "object",
"required": [
"name",
"state",
"json_configuration",
"id",
"team_name",
"team_id"
],
"title": "PipelineRead",
"description": "Response model for reading a pipeline's details."
}
Response 403 Forbidden
{
"detail": "Unauthorized."
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ResponseModel403",
"description": "Response model for 403 Forbidden."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /pipelines/{pipeline_id}/start
Start pipeline execution
Description
Start the pipeline's worker process, requires write permission on the pipeline's team.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
pipeline_id |
path | string | No | UUID of the pipeline to start |
Response 200 OK
"draft"
Schema of the response body
{
"type": "string",
"enum": [
"draft",
"building",
"paused",
"error",
"live"
],
"title": "PipelineState",
"description": "Handle pipeline states."
}
Response 403 Forbidden
{
"detail": "Unauthorized."
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ResponseModel403",
"description": "Response model for 403 Forbidden."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /pipelines/{pipeline_id}/pause
Pause pipeline execution
Description
Pause the running pipeline, requires access permission.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
pipeline_id |
path | string | No | UUID of the pipeline to pause |
Response 200 OK
"draft"
Schema of the response body
{
"type": "string",
"enum": [
"draft",
"building",
"paused",
"error",
"live"
],
"title": "PipelineState",
"description": "Handle pipeline states."
}
Response 403 Forbidden
{
"detail": "Unauthorized."
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ResponseModel403",
"description": "Response model for 403 Forbidden."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /pipelines/{pipeline_id}/logs
Get pipeline logs
Description
Retrieve logs of a pipeline execution.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
pipeline_id |
path | string | No | UUID of the pipeline to get logs for |
Response 200 OK
{
"uuid": "string",
"status": "Running",
"count_errors": "3",
"logs": "string"
}
Schema of the response body
{
"properties": {
"uuid": {
"type": "string",
"title": "Uuid",
"description": "UUID of the pipeline run or worker"
},
"status": {
"type": "string",
"enum": [
"Running",
"NotFound",
"Pending",
"Succeeded",
"Failed",
"Unknown"
],
"title": "Status",
"description": "Status of the current pipeline run"
},
"count_errors": {
"type": "string",
"title": "Count Errors",
"description": "Number of errors encountered during run",
"example": "3"
},
"logs": {
"type": "string",
"title": "Logs",
"description": "Logs produced by the pipeline worker"
}
},
"type": "object",
"required": [
"uuid",
"status",
"count_errors",
"logs"
],
"title": "PipelineLogs",
"description": "Status and logs for a pipeline worker."
}
Response 403 Forbidden
{
"detail": "Unauthorized."
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ResponseModel403",
"description": "Response model for 403 Forbidden."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /pipelines/{pipeline_id}/status
Get pipeline status
Description
Get the current status of the pipeline, refreshing state from worker logs.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
pipeline_id |
path | string | No | UUID of the pipeline to get status for |
Response 200 OK
{
"name": "string",
"state": "draft",
"json_configuration": {
"source_name": "postgres-source",
"source_type": null,
"source_config": {},
"target_name": "kafka-target",
"target_type": null,
"target_config": {},
"smt_name": "string",
"smt_config": [
null
],
"draft_step": "string"
},
"id": "7fdcb748-0108-4053-b526-39195ec26ac1",
"team_name": "string",
"team_id": "4ee35b26-71ed-4ba7-9784-7669642311fa"
}
Schema of the response body
{
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the pipeline"
},
"state": {
"$ref": "#/components/schemas/PipelineState",
"description": "Current state of the pipeline"
},
"json_configuration": {
"$ref": "#/components/schemas/PipelineConfigAsSerializer-Output",
"description": "Pipeline configuration structure"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier of the pipeline"
},
"team_name": {
"type": "string",
"title": "Team Name",
"description": "Name of the team that owns the pipeline"
},
"team_id": {
"type": "string",
"format": "uuid",
"title": "Team Id",
"description": "UUID of the owning team"
}
},
"type": "object",
"required": [
"name",
"state",
"json_configuration",
"id",
"team_name",
"team_id"
],
"title": "PipelineRead",
"description": "Response model for reading a pipeline's details."
}
Response 403 Forbidden
{
"detail": "Unauthorized."
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ResponseModel403",
"description": "Response model for 403 Forbidden."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /pipelines/{pipeline_id}/configuration
Export pipeline configuration
Description
Export the JSON configuration of the pipeline.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
pipeline_id |
path | string | No | UUID of the pipeline to export config for |
Response 200 OK
{
"source_name": "postgres-source",
"source_type": null,
"source_config": {},
"target_name": "kafka-target",
"target_type": null,
"target_config": {},
"smt_name": "string",
"smt_config": [
null
],
"draft_step": "string"
}
Schema of the response body
{
"properties": {
"source_name": {
"type": "string",
"title": "Source Name",
"description": "Name of the source connector",
"example": "postgres-source"
},
"source_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ConnectorType"
},
{
"type": "null"
}
],
"description": "Type of the source connector"
},
"source_config": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
]
},
"type": "object",
"title": "Source Config",
"description": "Configuration parameters for the source connector"
},
"target_name": {
"type": "string",
"title": "Target Name",
"description": "Name of the target connector",
"example": "kafka-target"
},
"target_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ConnectorType"
},
{
"type": "null"
}
],
"description": "Type of the target connector"
},
"target_config": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
]
},
"type": "object",
"title": "Target Config",
"description": "Configuration parameters for the target connector"
},
"smt_name": {
"type": "string",
"title": "Smt Name",
"description": "Name of the SMT (Simple Message Transform) applied"
},
"smt_config": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/MapperFunctionConfiguration-Output"
},
{
"$ref": "#/components/schemas/EmptyFunctionConfiguration"
},
{
"$ref": "#/components/schemas/FlattenerFunctionConfiguration"
},
{
"$ref": "#/components/schemas/SplitterFunctionConfiguration"
},
{
"$ref": "#/components/schemas/StringifyListFunctionConfiguration"
},
{
"$ref": "#/components/schemas/StringifyFunctionConfiguration"
},
{
"$ref": "#/components/schemas/UnenvelopeFunctionConfiguration"
},
{
"$ref": "#/components/schemas/KeyFilterFunctionConfiguration"
},
{
"$ref": "#/components/schemas/KeyMoverFunctionConfiguration"
},
{
"$ref": "#/components/schemas/DictMoverFunctionConfiguration"
},
{
"$ref": "#/components/schemas/KeyNormalizerFunctionConfiguration"
},
{
"$ref": "#/components/schemas/HashFunctionConfiguration"
},
{
"$ref": "#/components/schemas/EncryptFunctionConfiguration"
},
{
"$ref": "#/components/schemas/FilteringFunctionConfiguration"
}
]
},
"type": "array",
"title": "Smt Config",
"description": "List of transformation configurations"
},
"draft_step": {
"type": "string",
"title": "Draft Step",
"description": "Current draft step of the pipeline (e.g., 'config', 'review')"
}
},
"type": "object",
"required": [
"source_name",
"source_type",
"source_config",
"target_name",
"target_type",
"target_config",
"smt_name",
"smt_config",
"draft_step"
],
"title": "PipelineConfigAsSerializer",
"description": "Configuration structure for a pipeline.\n\nDescribes connectors and transformation details."
}
Response 403 Forbidden
{
"detail": "Unauthorized."
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ResponseModel403",
"description": "Response model for 403 Forbidden."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /pipelines/{pipeline_id}/configuration
Import pipeline configuration
Description
Update pipeline configuration by importing a new JSON config,requires write permission.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
pipeline_id |
path | string | No | UUID of the pipeline to import config for |
Request body
{
"source_name": "postgres-source",
"source_type": null,
"source_config": {},
"target_name": "kafka-target",
"target_type": null,
"target_config": {},
"smt_name": "string",
"smt_config": [
null
],
"draft_step": "string"
}
Schema of the request body
{
"properties": {
"source_name": {
"type": "string",
"title": "Source Name",
"description": "Name of the source connector",
"example": "postgres-source"
},
"source_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ConnectorType"
},
{
"type": "null"
}
],
"description": "Type of the source connector"
},
"source_config": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
]
},
"type": "object",
"title": "Source Config",
"description": "Configuration parameters for the source connector"
},
"target_name": {
"type": "string",
"title": "Target Name",
"description": "Name of the target connector",
"example": "kafka-target"
},
"target_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ConnectorType"
},
{
"type": "null"
}
],
"description": "Type of the target connector"
},
"target_config": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
]
},
"type": "object",
"title": "Target Config",
"description": "Configuration parameters for the target connector"
},
"smt_name": {
"type": "string",
"title": "Smt Name",
"description": "Name of the SMT (Simple Message Transform) applied"
},
"smt_config": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/MapperFunctionConfiguration-Input"
},
{
"$ref": "#/components/schemas/EmptyFunctionConfiguration"
},
{
"$ref": "#/components/schemas/FlattenerFunctionConfiguration"
},
{
"$ref": "#/components/schemas/SplitterFunctionConfiguration"
},
{
"$ref": "#/components/schemas/StringifyListFunctionConfiguration"
},
{
"$ref": "#/components/schemas/StringifyFunctionConfiguration"
},
{
"$ref": "#/components/schemas/UnenvelopeFunctionConfiguration"
},
{
"$ref": "#/components/schemas/KeyFilterFunctionConfiguration"
},
{
"$ref": "#/components/schemas/KeyMoverFunctionConfiguration"
},
{
"$ref": "#/components/schemas/DictMoverFunctionConfiguration"
},
{
"$ref": "#/components/schemas/KeyNormalizerFunctionConfiguration"
},
{
"$ref": "#/components/schemas/HashFunctionConfiguration"
},
{
"$ref": "#/components/schemas/EncryptFunctionConfiguration"
},
{
"$ref": "#/components/schemas/FilteringFunctionConfiguration"
}
]
},
"type": "array",
"title": "Smt Config",
"description": "List of transformation configurations"
},
"draft_step": {
"type": "string",
"title": "Draft Step",
"description": "Current draft step of the pipeline (e.g., 'config', 'review')"
}
},
"type": "object",
"required": [
"source_name",
"source_type",
"source_config",
"target_name",
"target_type",
"target_config",
"smt_name",
"smt_config",
"draft_step"
],
"title": "PipelineConfigAsSerializer",
"description": "Configuration structure for a pipeline.\n\nDescribes connectors and transformation details."
}
Response 200 OK
{
"source_name": "postgres-source",
"source_type": null,
"source_config": {},
"target_name": "kafka-target",
"target_type": null,
"target_config": {},
"smt_name": "string",
"smt_config": [
null
],
"draft_step": "string"
}
Schema of the response body
{
"properties": {
"source_name": {
"type": "string",
"title": "Source Name",
"description": "Name of the source connector",
"example": "postgres-source"
},
"source_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ConnectorType"
},
{
"type": "null"
}
],
"description": "Type of the source connector"
},
"source_config": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
]
},
"type": "object",
"title": "Source Config",
"description": "Configuration parameters for the source connector"
},
"target_name": {
"type": "string",
"title": "Target Name",
"description": "Name of the target connector",
"example": "kafka-target"
},
"target_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ConnectorType"
},
{
"type": "null"
}
],
"description": "Type of the target connector"
},
"target_config": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
]
},
"type": "object",
"title": "Target Config",
"description": "Configuration parameters for the target connector"
},
"smt_name": {
"type": "string",
"title": "Smt Name",
"description": "Name of the SMT (Simple Message Transform) applied"
},
"smt_config": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/MapperFunctionConfiguration-Output"
},
{
"$ref": "#/components/schemas/EmptyFunctionConfiguration"
},
{
"$ref": "#/components/schemas/FlattenerFunctionConfiguration"
},
{
"$ref": "#/components/schemas/SplitterFunctionConfiguration"
},
{
"$ref": "#/components/schemas/StringifyListFunctionConfiguration"
},
{
"$ref": "#/components/schemas/StringifyFunctionConfiguration"
},
{
"$ref": "#/components/schemas/UnenvelopeFunctionConfiguration"
},
{
"$ref": "#/components/schemas/KeyFilterFunctionConfiguration"
},
{
"$ref": "#/components/schemas/KeyMoverFunctionConfiguration"
},
{
"$ref": "#/components/schemas/DictMoverFunctionConfiguration"
},
{
"$ref": "#/components/schemas/KeyNormalizerFunctionConfiguration"
},
{
"$ref": "#/components/schemas/HashFunctionConfiguration"
},
{
"$ref": "#/components/schemas/EncryptFunctionConfiguration"
},
{
"$ref": "#/components/schemas/FilteringFunctionConfiguration"
}
]
},
"type": "array",
"title": "Smt Config",
"description": "List of transformation configurations"
},
"draft_step": {
"type": "string",
"title": "Draft Step",
"description": "Current draft step of the pipeline (e.g., 'config', 'review')"
}
},
"type": "object",
"required": [
"source_name",
"source_type",
"source_config",
"target_name",
"target_type",
"target_config",
"smt_name",
"smt_config",
"draft_step"
],
"title": "PipelineConfigAsSerializer",
"description": "Configuration structure for a pipeline.\n\nDescribes connectors and transformation details."
}
Response 403 Forbidden
{
"detail": "Unauthorized."
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ResponseModel403",
"description": "Response model for 403 Forbidden."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /pipelines/status/all-non-draft
List status of all non-draft pipelines
Description
Retrieve a paginated list of all pipelines that are not in DRAFT state. Supports filtering by state (excluding DRAFT by default), team, and search. Returns pipeline status and summary information.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
page |
query | integer | 1 | No | |
search |
query | None | No | Search term to filter pipelines by name or description. | |
size |
query | integer | 50 | No | |
state |
query | None | No | Filter pipelines by state (e.g., BUILDING, PAUSED, LIVE, ERROR). If omitted, returns all non-draft pipelines. | |
team_id |
query | None | No | Filter pipelines by the ID of the team they belong to. |
Response 200 OK
{
"items": [
{
"id": "c69b4ff6-f2ff-4ef2-aeae-c20633a27b5d",
"name": "string",
"state": "draft"
}
],
"total": null,
"page": null,
"size": null,
"pages": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/PipelineStateList"
},
"type": "array",
"title": "Items"
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Total"
},
"page": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Page"
},
"size": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Size"
},
"pages": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size"
],
"title": "Page[PipelineStateList]"
}
Response 403 Forbidden
{
"detail": "Unauthorized."
}
Schema of the response body
{
"properties": {
"detail": {
"type": "string",
"title": "Detail"
}
},
"type": "object",
"required": [
"detail"
],
"title": "ResponseModel403",
"description": "Response model for 403 Forbidden."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
brokers
POST /brokers/
Brokers:Test
Description
Test the broker credentials.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"bootstrap_server": "string",
"security_protocol": "PLAINTEXT",
"sasl_mechanism": "OAUTHBEARER",
"sasl_username": "string",
"sasl_password": "string",
"ca_cert": "string"
}
Schema of the request body
{
"properties": {
"bootstrap_server": {
"type": "string",
"title": "Bootstrap Server"
},
"security_protocol": {
"type": "string",
"enum": [
"PLAINTEXT",
"SASL_PLAINTEXT",
"SASL_SSL",
"SSL"
],
"title": "Security Protocol"
},
"sasl_mechanism": {
"type": "string",
"enum": [
"OAUTHBEARER",
"PLAIN",
"SCRAM-SHA-256",
"SCRAM-SHA-512",
"GSSAPI"
],
"title": "Sasl Mechanism"
},
"sasl_username": {
"type": "string",
"title": "Sasl Username"
},
"sasl_password": {
"type": "string",
"title": "Sasl Password"
},
"ca_cert": {
"type": "string",
"title": "Ca Cert",
"default": ""
}
},
"type": "object",
"required": [
"bootstrap_server",
"security_protocol",
"sasl_mechanism",
"sasl_username",
"sasl_password"
],
"title": "BrokerConfiguration",
"description": "Broker configuration."
}
Response 200 OK
{
"status": true
}
Schema of the response body
{
"properties": {
"status": {
"type": "boolean",
"title": "Status"
}
},
"type": "object",
"required": [
"status"
],
"title": "BrokerCheckStatus",
"description": "Broker check status."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
env_member
GET /envs/members
Env Member:List
Description
List the environment members of the specified environment.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
page |
query | integer | 1 | No | |
size |
query | integer | 50 | No |
Response 200 OK
{
"items": [
{
"id": "b0fff2b1-083e-4bf4-8b8b-b1c4134ad89d",
"user_id": "d8c4525d-303a-4a33-8b60-6138954ab553",
"email": "string",
"admin": true
}
],
"total": null,
"page": null,
"size": null,
"pages": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/EnvMemberList"
},
"type": "array",
"title": "Items"
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Total"
},
"page": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Page"
},
"size": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Size"
},
"pages": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size"
],
"title": "Page[EnvMemberList]"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /envs/members/me
Env Member:Get Me
Description
Read the environment member of the current user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
{
"user_id": "35bab172-9e28-4192-804b-552a09ac4dd6",
"env_id": "f3cefe77-264c-4a58-bb86-7908ffa7fa3e",
"admin": true,
"id": "a735e019-334f-4dab-9e60-6cb428a412dc"
}
Schema of the response body
{
"properties": {
"user_id": {
"type": "string",
"format": "uuid",
"title": "User Id",
"description": "Unique identifier of the user being added",
"examples": [
"d290f1ee-6c54-4b01-90e6-d701748f0851"
]
},
"env_id": {
"type": "string",
"format": "uuid",
"title": "Env Id",
"description": "Unique identifier of the env",
"examples": [
"a7d1f2fc-6e92-4dcd-b1f6-4200e4e9f1f3"
]
},
"admin": {
"type": "boolean",
"title": "Admin",
"description": "Whether the user has admin privileges in the env",
"examples": [
true
]
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier of the env member entry",
"examples": [
"b154b9c4-4b28-4c6b-97c2-fdab3ed37f0e"
]
}
},
"type": "object",
"required": [
"user_id",
"env_id",
"admin",
"id"
],
"title": "EnvMemberRead",
"description": "Response model for reading a env member."
}
envs
POST /envs/
Envs:Create
Description
Create env.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"name": "string",
"use_retention": true,
"retention_configuration": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the environment",
"examples": [
"staging"
]
},
"use_retention": {
"type": "boolean",
"title": "Use Retention",
"description": "Whether message retention is enabled for this environment",
"examples": [
true
]
},
"retention_configuration": {
"anyOf": [
{
"$ref": "#/components/schemas/BrokerConfiguration"
},
{
"type": "null"
}
],
"description": "Retention policy configuration if retention is enabled"
}
},
"type": "object",
"required": [
"name",
"use_retention"
],
"title": "EnvCreate",
"description": "Model used to create a new Env.\n\nIncludes the environment name and optional broker retention configuration."
}
Response 201 Created
{
"name": "string",
"use_retention": true,
"retention_configuration": null,
"id": "378061df-6268-4fda-a715-cb8927ac5454"
}
Schema of the response body
{
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the environment",
"examples": [
"staging"
]
},
"use_retention": {
"type": "boolean",
"title": "Use Retention",
"description": "Whether message retention is enabled for this environment",
"examples": [
true
]
},
"retention_configuration": {
"anyOf": [
{
"$ref": "#/components/schemas/BrokerConfiguration"
},
{
"type": "null"
}
],
"description": "Retention policy configuration if retention is enabled"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier of the environment"
}
},
"type": "object",
"required": [
"name",
"use_retention",
"id"
],
"title": "EnvRead",
"description": "Model returned when reading an Env.\n\nIncludes all creation fields plus the unique Env identifier."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /envs/
Envs:List
Description
Envs for environment members.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
page |
query | integer | 1 | No | |
size |
query | integer | 50 | No |
Response 200 OK
{
"items": [
{
"id": "88b1b016-0481-4c39-9313-9f93387dac5e",
"name": "string"
}
],
"total": null,
"page": null,
"size": null,
"pages": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/EnvList"
},
"type": "array",
"title": "Items"
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Total"
},
"page": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Page"
},
"size": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Size"
},
"pages": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size"
],
"title": "Page[EnvList]"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /envs/{env_id}
Envs:Get
Description
Read an env.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
env_id |
path | string | No |
Response 200 OK
{
"name": "string",
"use_retention": true,
"retention_configuration": null,
"id": "f98d9559-d5f5-4ce7-8ca6-577bf1b5eec2"
}
Schema of the response body
{
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the environment",
"examples": [
"staging"
]
},
"use_retention": {
"type": "boolean",
"title": "Use Retention",
"description": "Whether message retention is enabled for this environment",
"examples": [
true
]
},
"retention_configuration": {
"anyOf": [
{
"$ref": "#/components/schemas/BrokerConfiguration"
},
{
"type": "null"
}
],
"description": "Retention policy configuration if retention is enabled"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier of the environment"
}
},
"type": "object",
"required": [
"name",
"use_retention",
"id"
],
"title": "EnvRead",
"description": "Model returned when reading an Env.\n\nIncludes all creation fields plus the unique Env identifier."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /envs/{env_id}
Envs:Update
Description
Update an env. Only env admins can update environments.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
env_id |
path | string | No |
Request body
{
"name": null,
"use_retention": null,
"retention_configuration": null
}
Schema of the request body
{
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "Name of the environment",
"examples": [
"staging"
]
},
"use_retention": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Use Retention",
"description": "Whether message retention is enabled for this environment",
"examples": [
true
]
},
"retention_configuration": {
"anyOf": [
{
"$ref": "#/components/schemas/BrokerConfiguration"
},
{
"type": "null"
}
],
"description": "Retention policy configuration if retention is enabled"
}
},
"type": "object",
"title": "EnvUpdate",
"description": "Model used to update an existing Env.\n\nAll fields are optional to allow partial updates."
}
Response 200 OK
{
"name": "string",
"use_retention": true,
"retention_configuration": null,
"id": "250dde44-2c15-4443-b4a1-813421ff60f9"
}
Schema of the response body
{
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the environment",
"examples": [
"staging"
]
},
"use_retention": {
"type": "boolean",
"title": "Use Retention",
"description": "Whether message retention is enabled for this environment",
"examples": [
true
]
},
"retention_configuration": {
"anyOf": [
{
"$ref": "#/components/schemas/BrokerConfiguration"
},
{
"type": "null"
}
],
"description": "Retention policy configuration if retention is enabled"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier of the environment"
}
},
"type": "object",
"required": [
"name",
"use_retention",
"id"
],
"title": "EnvRead",
"description": "Model returned when reading an Env.\n\nIncludes all creation fields plus the unique Env identifier."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
connector types
POST /kafka-source/check-credentials
Kafka-Source:Check-Credentials
Description
Check the kafka source credentials.
Request body
{
"topic": "string",
"consumer_group_id": null,
"sasl_username": "string",
"sasl_password": "string",
"bootstrap_servers": "string",
"security_protocol": "PLAINTEXT",
"sasl_mechanism": "OAUTHBEARER",
"include_metadata": null
}
Schema of the request body
{
"properties": {
"topic": {
"type": "string",
"title": "Topic",
"description": "Kafka topic to consume from",
"examples": [
"user_events"
]
},
"consumer_group_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Consumer Group Id",
"description": "Optional consumer group ID for Kafka consumption",
"examples": [
"pipeline-group-1"
]
},
"sasl_username": {
"type": "string",
"title": "Sasl Username",
"description": "SASL username for authentication",
"examples": [
"kafka_user"
]
},
"sasl_password": {
"type": "string",
"title": "Sasl Password",
"description": "SASL password for authentication",
"examples": [
"securePassword123!"
]
},
"bootstrap_servers": {
"type": "string",
"title": "Bootstrap Servers",
"description": "Comma-separated list of Kafka bootstrap servers",
"examples": [
"kafka1:9092,kafka2:9092"
]
},
"security_protocol": {
"type": "string",
"enum": [
"PLAINTEXT",
"SASL_PLAINTEXT",
"SASL_SSL",
"SSL"
],
"title": "Security Protocol",
"description": "Kafka security protocol to use",
"examples": [
"SASL_SSL"
]
},
"sasl_mechanism": {
"type": "string",
"enum": [
"OAUTHBEARER",
"PLAIN",
"SCRAM-SHA-256",
"SCRAM-SHA-512",
"GSSAPI"
],
"title": "Sasl Mechanism",
"description": "SASL mechanism used for authentication",
"examples": [
"SCRAM-SHA-512"
]
},
"include_metadata": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Include Metadata",
"description": "Whether to include Kafka message metadata in the response",
"default": false,
"examples": [
false
]
}
},
"type": "object",
"required": [
"topic",
"consumer_group_id",
"sasl_username",
"sasl_password",
"bootstrap_servers",
"security_protocol",
"sasl_mechanism"
],
"title": "KafkaSourceCredentials",
"description": "Credentials and configuration for accessing a Kafka source."
}
Response 200 OK
{
"is_success": true,
"message": "string"
}
Schema of the response body
{
"properties": {
"is_success": {
"type": "boolean",
"title": "Is Success"
},
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"is_success",
"message"
],
"title": "CredentialsResponse",
"description": "Credential response."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /kafka-source/fetch-messages
Kafka-Source:Fetch-Messages
Description
Fetch some messages from the connector configuration.
Request body
{
"topic": "string",
"consumer_group_id": null,
"sasl_username": "string",
"sasl_password": "string",
"bootstrap_servers": "string",
"security_protocol": "PLAINTEXT",
"sasl_mechanism": "OAUTHBEARER",
"include_metadata": null
}
Schema of the request body
{
"properties": {
"topic": {
"type": "string",
"title": "Topic",
"description": "Kafka topic to consume from",
"examples": [
"user_events"
]
},
"consumer_group_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Consumer Group Id",
"description": "Optional consumer group ID for Kafka consumption",
"examples": [
"pipeline-group-1"
]
},
"sasl_username": {
"type": "string",
"title": "Sasl Username",
"description": "SASL username for authentication",
"examples": [
"kafka_user"
]
},
"sasl_password": {
"type": "string",
"title": "Sasl Password",
"description": "SASL password for authentication",
"examples": [
"securePassword123!"
]
},
"bootstrap_servers": {
"type": "string",
"title": "Bootstrap Servers",
"description": "Comma-separated list of Kafka bootstrap servers",
"examples": [
"kafka1:9092,kafka2:9092"
]
},
"security_protocol": {
"type": "string",
"enum": [
"PLAINTEXT",
"SASL_PLAINTEXT",
"SASL_SSL",
"SSL"
],
"title": "Security Protocol",
"description": "Kafka security protocol to use",
"examples": [
"SASL_SSL"
]
},
"sasl_mechanism": {
"type": "string",
"enum": [
"OAUTHBEARER",
"PLAIN",
"SCRAM-SHA-256",
"SCRAM-SHA-512",
"GSSAPI"
],
"title": "Sasl Mechanism",
"description": "SASL mechanism used for authentication",
"examples": [
"SCRAM-SHA-512"
]
},
"include_metadata": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Include Metadata",
"description": "Whether to include Kafka message metadata in the response",
"default": false,
"examples": [
false
]
}
},
"type": "object",
"required": [
"topic",
"consumer_group_id",
"sasl_username",
"sasl_password",
"bootstrap_servers",
"security_protocol",
"sasl_mechanism"
],
"title": "KafkaSourceCredentials",
"description": "Credentials and configuration for accessing a Kafka source."
}
Response 200 OK
{
"messages": [
{}
]
}
Schema of the response body
{
"properties": {
"messages": {
"items": {
"type": "object"
},
"type": "array",
"title": "Messages"
}
},
"type": "object",
"required": [
"messages"
],
"title": "Messages",
"description": "Messages."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /oracle-target/check-credentials
Oracle-Target:Check-Credentials
Description
Check oracle target credentials.
Request body
{
"database": "string",
"user": "string",
"password": "string",
"host": "string",
"port": "string",
"server_name": "string",
"server_id": "string"
}
Schema of the request body
{
"properties": {
"database": {
"type": "string",
"title": "Database",
"description": "Oracle database name",
"examples": [
"ORCL"
]
},
"user": {
"type": "string",
"title": "User",
"description": "Username for the Oracle database",
"examples": [
"admin_user"
]
},
"password": {
"type": "string",
"title": "Password",
"description": "Password for the Oracle database",
"examples": [
"StrongPass123"
]
},
"host": {
"type": "string",
"title": "Host",
"description": "Hostname or IP address of the Oracle server",
"examples": [
"192.168.1.100"
]
},
"port": {
"type": "string",
"title": "Port",
"description": "Port number used to connect to the Oracle server",
"examples": [
"1521"
]
},
"server_name": {
"type": "string",
"title": "Server Name",
"description": "Oracle server name (e.g., service name)",
"examples": [
"XE"
]
},
"server_id": {
"type": "string",
"title": "Server Id",
"description": "Oracle server identifier (e.g., SID)",
"examples": [
"oraclesrv01"
]
}
},
"type": "object",
"required": [
"database",
"user",
"password",
"host",
"port",
"server_name",
"server_id"
],
"title": "OracleTargetCredentials",
"description": "Credentials and connection details for writing to an Oracle target."
}
Response 200 OK
{
"is_success": true,
"message": "string"
}
Schema of the response body
{
"properties": {
"is_success": {
"type": "boolean",
"title": "Is Success"
},
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"is_success",
"message"
],
"title": "CredentialsResponse",
"description": "Credential response."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
jobs-smt
POST /smt/process_mapper
Job-Smt:Process-Mapper
Description
Process mapper.
Request body
{
"config": [
{
"table_name": "string",
"fields": [
{
"key": "string",
"path": "string",
"static": "string",
"nullable": true
}
]
}
],
"message": {}
}
Schema of the request body
{
"properties": {
"config": {
"items": {
"$ref": "#/components/schemas/MapperTableConfig"
},
"type": "array",
"title": "Config"
},
"message": {
"type": "object",
"title": "Message"
}
},
"type": "object",
"required": [
"config",
"message"
],
"title": "Body_job_smt_process_mapper_smt_process_mapper_post"
}
Response 200 OK
[
{}
]
Schema of the response body
{
"items": {
"type": "object"
},
"type": "array",
"title": "Response Job Smt Process Mapper Smt Process Mapper Post"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /smt/process_flattener
Job-Smt:Process-Flattener
Description
Process flattener.
Request body
Schema of the request body
{
"type": "object",
"title": "Message"
}
Response 200 OK
[
[
{}
]
]
Schema of the response body
{
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"type": "array",
"title": "Response Job Smt Process Flattener Smt Process Flattener Post"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /smt/process_splitter
Job-Smt:Process-Splitter
Description
Process splitter.
Request body
{
"config": {
"root_table_name": "string",
"popsink_pk": "string",
"pk": null,
"abbreviate_len": null
},
"message": {}
}
Schema of the request body
{
"properties": {
"config": {
"$ref": "#/components/schemas/SplitterConfiguration"
},
"message": {
"type": "object",
"title": "Message"
}
},
"type": "object",
"required": [
"config",
"message"
],
"title": "Body_job_smt_process_splitter_smt_process_splitter_post"
}
Response 200 OK
[
{}
]
Schema of the response body
{
"items": {
"type": "object"
},
"type": "array",
"title": "Response Job Smt Process Splitter Smt Process Splitter Post"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /smt/process_stringify_list
Job-Smt:Process-Stringify-List
Description
Process stringify list.
Request body
Schema of the request body
{
"type": "object",
"title": "Message"
}
Response 200 OK
[
[
{}
]
]
Schema of the response body
{
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"type": "array",
"title": "Response Job Smt Process Stringify List Smt Process Stringify List Post"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /smt/process_stringify_key
Job-Smt:Process-Stringify-Key
Description
Process stringify key.
Request body
{
"config": {
"keys": [
"string"
]
},
"message": {}
}
Schema of the request body
{
"properties": {
"config": {
"$ref": "#/components/schemas/KeysConfiguration"
},
"message": {
"type": "object",
"title": "Message"
}
},
"type": "object",
"required": [
"config",
"message"
],
"title": "Body_job_smt_process_stringify_key_smt_process_stringify_key_post"
}
Response 200 OK
[
[
{}
]
]
Schema of the response body
{
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"type": "array",
"title": "Response Job Smt Process Stringify Key Smt Process Stringify Key Post"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /smt/process_unenvelope
Job-Smt:Process-Unenvelope
Description
Process unenvelope.
Request body
{
"config": {
"key": "string"
},
"message": {}
}
Schema of the request body
{
"properties": {
"config": {
"$ref": "#/components/schemas/KeyConfiguration"
},
"message": {
"type": "object",
"title": "Message"
}
},
"type": "object",
"required": [
"config",
"message"
],
"title": "Body_job_smt_process_unenvelope_smt_process_unenvelope_post"
}
Response 200 OK
[
[
{}
]
]
Schema of the response body
{
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"type": "array",
"title": "Response Job Smt Process Unenvelope Smt Process Unenvelope Post"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /smt/process_key_filter
Job-Smt:Process-Key-Filter
Description
Process key filter.
Request body
{
"config": {
"keys": [
"string"
]
},
"message": {}
}
Schema of the request body
{
"properties": {
"config": {
"$ref": "#/components/schemas/KeysConfiguration"
},
"message": {
"type": "object",
"title": "Message"
}
},
"type": "object",
"required": [
"config",
"message"
],
"title": "Body_job_smt_process_key_filter_smt_process_key_filter_post"
}
Response 200 OK
[
[
{}
]
]
Schema of the response body
{
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"type": "array",
"title": "Response Job Smt Process Key Filter Smt Process Key Filter Post"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /smt/process_key_mover
Job-Smt:Process-Key-Mover
Description
Process key mover.
Request body
{
"config": [
{
"key": "string",
"key_path": "string"
}
],
"message": {}
}
Schema of the request body
{
"properties": {
"config": {
"items": {
"$ref": "#/components/schemas/KeyMoverConfig"
},
"type": "array",
"title": "Config"
},
"message": {
"type": "object",
"title": "Message"
}
},
"type": "object",
"required": [
"config",
"message"
],
"title": "Body_job_smt_process_key_mover_smt_process_key_mover_post"
}
Response 200 OK
[
[
{}
]
]
Schema of the response body
{
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"type": "array",
"title": "Response Job Smt Process Key Mover Smt Process Key Mover Post"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /smt/process_dict_mover
Job-Smt:Process-Dict-Mover
Description
Process dict mover.
Request body
{
"config": {
"keys": [
"string"
]
},
"message": {}
}
Schema of the request body
{
"properties": {
"config": {
"$ref": "#/components/schemas/KeysConfiguration"
},
"message": {
"type": "object",
"title": "Message"
}
},
"type": "object",
"required": [
"config",
"message"
],
"title": "Body_job_smt_process_dict_mover_smt_process_dict_mover_post"
}
Response 200 OK
[
[
{}
]
]
Schema of the response body
{
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"type": "array",
"title": "Response Job Smt Process Dict Mover Smt Process Dict Mover Post"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /smt/process_sanitize_key
Job-Smt:Process-Sanitize-Key
Description
Process sanitize key.
Request body
Schema of the request body
{
"type": "object",
"title": "Message"
}
Response 200 OK
[
[
{}
]
]
Schema of the response body
{
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"type": "array",
"title": "Response Job Smt Process Sanitize Key Smt Process Sanitize Key Post"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /smt/process_hash
Job-Smt:Process-Hash
Description
Process hash.
Request body
{
"config": {
"hash_type": "MD5",
"paths": [
"string"
]
},
"message": {}
}
Schema of the request body
{
"properties": {
"config": {
"$ref": "#/components/schemas/HashConfig"
},
"message": {
"type": "object",
"title": "Message"
}
},
"type": "object",
"required": [
"config",
"message"
],
"title": "Body_job_smt_process_hash_smt_process_hash_post"
}
Response 200 OK
[
[
{}
]
]
Schema of the response body
{
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"type": "array",
"title": "Response Job Smt Process Hash Smt Process Hash Post"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /smt/process_encryption
Job-Smt:Process-Encryption
Description
Process encryption.
Request body
{
"config": {
"encrypt_key": "string",
"paths": [
"string"
]
},
"message": {}
}
Schema of the request body
{
"properties": {
"config": {
"$ref": "#/components/schemas/EncryptConfiguration"
},
"message": {
"type": "object",
"title": "Message"
}
},
"type": "object",
"required": [
"config",
"message"
],
"title": "Body_job_smt_process_encryption_smt_process_encryption_post"
}
Response 200 OK
[
[
{}
]
]
Schema of the response body
{
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"type": "array",
"title": "Response Job Smt Process Encryption Smt Process Encryption Post"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /smt/process_filtering
Job-Smt:Process-Filtering
Description
Process filtering.
Request body
{
"config": {
"operator": "EQUAL",
"key": "string",
"value": "string"
},
"message": {}
}
Schema of the request body
{
"properties": {
"config": {
"$ref": "#/components/schemas/FilteringConfiguration"
},
"message": {
"type": "object",
"title": "Message"
}
},
"type": "object",
"required": [
"config",
"message"
],
"title": "Body_job_smt_process_filtering_smt_process_filtering_post"
}
Response 200 OK
[
[
{}
]
]
Schema of the response body
{
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"type": "array",
"title": "Response Job Smt Process Filtering Smt Process Filtering Post"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
teams
POST /teams/
Teams:Create
Description
Create a team.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
{
"name": "string",
"description": "string",
"env_id": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the team",
"examples": [
"Data Avengers"
]
},
"description": {
"type": "string",
"title": "Description",
"description": "Short description of the team",
"examples": [
"Team managing data pipelines and infrastructure."
]
},
"env_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Env Id",
"description": "Optional environment ID the team is associated with",
"examples": [
"bfe91314-1234-4c6f-bb0c-01867487cc23"
]
}
},
"type": "object",
"required": [
"name",
"description"
],
"title": "TeamCreate",
"description": "Request model for creating a new team."
}
Response 201 Created
{
"name": "string",
"description": "string",
"env_id": null,
"id": "b42eb212-de60-4bae-9fb6-86b174fef06e"
}
Schema of the response body
{
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the team",
"examples": [
"Data Avengers"
]
},
"description": {
"type": "string",
"title": "Description",
"description": "Short description of the team",
"examples": [
"Team managing data pipelines and infrastructure."
]
},
"env_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Env Id",
"description": "Optional environment ID the team is associated with",
"examples": [
"bfe91314-1234-4c6f-bb0c-01867487cc23"
]
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier for the team",
"examples": [
"8c18a0db-3b10-4f9b-a7d3-6e837bafacb0"
]
}
},
"type": "object",
"required": [
"name",
"description",
"id"
],
"title": "TeamRead",
"description": "Response model for reading a team."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /teams/
Teams:List
Description
List the teams of the current user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
page |
query | integer | 1 | No | |
size |
query | integer | 50 | No |
Response 200 OK
{
"items": [
{
"id": "3abcf0e5-02ff-42fb-9653-65a12e6a8ea9",
"name": "string"
}
],
"total": null,
"page": null,
"size": null,
"pages": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/TeamList"
},
"type": "array",
"title": "Items"
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Total"
},
"page": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Page"
},
"size": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Size"
},
"pages": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size"
],
"title": "Page[TeamList]"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /teams/{team_id}
Teams:Get
Description
Read a team.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
team_id |
path | string | No |
Response 200 OK
{
"name": "string",
"description": "string",
"env_id": null,
"id": "86a879b5-75b0-41bb-bc73-4018860eac51"
}
Schema of the response body
{
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the team",
"examples": [
"Data Avengers"
]
},
"description": {
"type": "string",
"title": "Description",
"description": "Short description of the team",
"examples": [
"Team managing data pipelines and infrastructure."
]
},
"env_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Env Id",
"description": "Optional environment ID the team is associated with",
"examples": [
"bfe91314-1234-4c6f-bb0c-01867487cc23"
]
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier for the team",
"examples": [
"8c18a0db-3b10-4f9b-a7d3-6e837bafacb0"
]
}
},
"type": "object",
"required": [
"name",
"description",
"id"
],
"title": "TeamRead",
"description": "Response model for reading a team."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
team_member
POST /teams/{team_id}/members/bulk
Team Member:Bulk Create
Description
Bulk create team members.
Add multiple users to a team as either members or owners. Returns 204 No Content on success. Users who are already team members will be skipped.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
team_id |
path | string | No |
Request body
{
"owners": [
"9b758d62-aae2-480a-82e0-5f44e95eb555"
],
"members": [
"7e758f07-da39-431e-a33c-24c7a6c709f1"
]
}
Schema of the request body
{
"properties": {
"owners": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Owners",
"description": "List of user IDs to add as team owners (admin=true)",
"default": [],
"examples": [
[
"d290f1ee-6c54-4b01-90e6-d701748f0851",
"e391f2fc-7e92-4dcd-b1f6-4200e4e9f1f4"
]
]
},
"members": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Members",
"description": "List of user IDs to add as team members (admin=false)",
"default": [],
"examples": [
[
"f492f3fd-8f93-4ede-c2f7-5301f5ea0f5",
"g593f4fe-9g94-4fef-d3g8-6412g6fb1g6"
]
]
}
},
"type": "object",
"title": "TeamMemberBulkCreate",
"description": "Request model for creating team members with separate owner and member lists."
}
Response 204 No Content
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /teams/{team_id}/members
Team Member:List
Description
List the team members of the specified team.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
page |
query | integer | 1 | No | |
size |
query | integer | 50 | No | |
team_id |
path | string | No |
Response 200 OK
{
"items": [
{
"id": "cd4cba39-c076-4a9d-9bf3-c42d27f0d223",
"user_id": "1e360204-e3ca-4dc2-b078-0d1faa64af4c",
"email": "string",
"admin": true
}
],
"total": null,
"page": null,
"size": null,
"pages": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/TeamMemberList"
},
"type": "array",
"title": "Items"
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Total"
},
"page": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Page"
},
"size": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Size"
},
"pages": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size"
],
"title": "Page[TeamMemberList]"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /teams/{team_id}/members/me
Team Member:Get
Description
Get the team member details of the current user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
team_id |
path | string | No |
Response 200 OK
{
"id": "5b2df704-2376-4f18-8dd9-ccb9cee1c270",
"user_id": "5868b819-ecea-4b3f-8ddd-98bb61263086",
"team_id": "89a2763d-0bb7-413b-8c29-200e473dbbb0",
"admin": true
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier of the team member entry",
"examples": [
"b154b9c4-4b28-4c6b-97c2-fdab3ed37f0e"
]
},
"user_id": {
"type": "string",
"format": "uuid",
"title": "User Id",
"description": "Unique identifier of the user being added",
"examples": [
"d290f1ee-6c54-4b01-90e6-d701748f0851"
]
},
"team_id": {
"type": "string",
"format": "uuid",
"title": "Team Id",
"description": "Unique identifier of the team",
"examples": [
"a7d1f2fc-6e92-4dcd-b1f6-4200e4e9f1f3"
]
},
"admin": {
"type": "boolean",
"title": "Admin",
"description": "Whether the user has admin privileges in the team",
"examples": [
true
]
}
},
"type": "object",
"required": [
"id",
"user_id",
"team_id",
"admin"
],
"title": "TeamMemberRead",
"description": "Response model for reading a team member."
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
team_request
GET /teams/requests/me
List user team requests with details
Description
List all requests addressed to the current user with user and team details.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
page |
query | integer | 1 | No | |
size |
query | integer | 50 | No |
Response 200 OK
{
"items": [
{
"id": "1cf9d14f-8456-4be8-ad92-3d8d89709f35",
"team_id": "c8385033-a680-4db1-b0e8-558f5c76d0d3",
"from_user_id": "4e0e2eda-1bf1-4d48-b003-8d84738d23d7",
"to_user_id": "b27cd0c7-9e51-4a33-957b-9a02fae1a27d",
"status": "PENDING",
"admin": true,
"created_at": null,
"updated_at": null,
"from_user_email": "string",
"team_name": "string"
}
],
"total": null,
"page": null,
"size": null,
"pages": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/TeamRequestListAsMember"
},
"type": "array",
"title": "Items"
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Total"
},
"page": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Page"
},
"size": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Size"
},
"pages": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size"
],
"title": "Page[TeamRequestListAsMember]"
}
Response 404 Not Found
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /teams/{team_id}/requests
List team requests
Description
List all requests for a given team.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
page |
query | integer | 1 | No | |
size |
query | integer | 50 | No | |
team_id |
path | string | No |
Response 200 OK
{
"items": [
{
"id": "a3da71b1-3fe1-4ab4-9767-29b0b32549e5",
"team_id": "812724eb-3a5b-443d-9865-d5d4c1ee8228",
"from_user_id": "e13e8c12-7f88-4c2a-8a63-19fc7472d60d",
"to_user_id": "87366d2b-2a94-4288-b344-5169f1c10b37",
"to_user_email": "string",
"status": "PENDING",
"admin": true,
"created_at": null,
"updated_at": null
}
],
"total": null,
"page": null,
"size": null,
"pages": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/TeamRequestListAsAdmin"
},
"type": "array",
"title": "Items"
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Total"
},
"page": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Page"
},
"size": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Size"
},
"pages": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size"
],
"title": "Page[TeamRequestListAsAdmin]"
}
Response 404 Not Found
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /teams/{team_id}/requests
Register a team request
Description
Register a new team request. Only team admins can send requests.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
team_id |
path | string | No |
Request body
{
"team_id": "cd0dca71-4f1f-4db7-a493-db5a7fce0612",
"from_user_id": "c6c50635-181a-4331-999b-3b0711a82baa",
"to_user_id": "40646ff6-5613-4a76-b16f-bd339cdc492f",
"status": null,
"admin": null
}
Schema of the request body
{
"properties": {
"team_id": {
"type": "string",
"format": "uuid",
"title": "Team Id",
"description": "ID of the team to which the user is being invited",
"examples": [
"e2a1d6c7-d50e-4b97-945c-cd842a4e674f"
]
},
"from_user_id": {
"type": "string",
"format": "uuid",
"title": "From User Id",
"description": "ID of the user who sends the invitation",
"examples": [
"1a5d50a9-b3de-4c63-8d46-1b7ebdee179b"
]
},
"to_user_id": {
"type": "string",
"format": "uuid",
"title": "To User Id",
"description": "ID of the user who receives the invitation",
"examples": [
"3f9bfe97-2f1e-4c6d-9d60-83665e3d8be0"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestStatus"
},
{
"type": "null"
}
],
"description": "Current status of the request",
"default": "PENDING",
"examples": [
"PENDING"
]
},
"admin": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Admin",
"description": "Whether the invited user will be admin if they accept",
"default": false,
"examples": [
false
]
}
},
"type": "object",
"required": [
"team_id",
"from_user_id",
"to_user_id"
],
"title": "TeamRequestCreate",
"description": "Request model for creating a team invitation request."
}
Response 201 Created
{
"team_id": "2ae77f48-470e-4a6d-82fa-6967c1edb171",
"from_user_id": "2f798bfd-7fa9-48f6-a0a6-94e4b82ccc11",
"to_user_id": "b167c39e-9c11-49d1-b853-fe11215d3eb0",
"status": null,
"admin": null,
"id": "08089917-cc03-4868-8e7f-84cd2b98ea68",
"created_at": null,
"updated_at": null
}
Schema of the response body
{
"properties": {
"team_id": {
"type": "string",
"format": "uuid",
"title": "Team Id",
"description": "ID of the team to which the user is being invited",
"examples": [
"e2a1d6c7-d50e-4b97-945c-cd842a4e674f"
]
},
"from_user_id": {
"type": "string",
"format": "uuid",
"title": "From User Id",
"description": "ID of the user who sends the invitation",
"examples": [
"1a5d50a9-b3de-4c63-8d46-1b7ebdee179b"
]
},
"to_user_id": {
"type": "string",
"format": "uuid",
"title": "To User Id",
"description": "ID of the user who receives the invitation",
"examples": [
"3f9bfe97-2f1e-4c6d-9d60-83665e3d8be0"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestStatus"
},
{
"type": "null"
}
],
"description": "Current status of the request",
"default": "PENDING",
"examples": [
"PENDING"
]
},
"admin": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Admin",
"description": "Whether the invited user will be admin if they accept",
"default": false,
"examples": [
false
]
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier for the team request",
"examples": [
"84f8e7cd-e040-4bfb-a2dc-16d65b8d5c16"
]
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At",
"description": "Timestamp when the request was created",
"examples": [
"2025-06-12T09:23:45"
]
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated At",
"description": "Timestamp when the request was last updated",
"examples": [
"2025-06-12T10:00:00"
]
}
},
"type": "object",
"required": [
"team_id",
"from_user_id",
"to_user_id",
"id"
],
"title": "TeamRequestRead",
"description": "Response model for reading a team request."
}
Response 404 Not Found
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /teams/{team_id}/requests/{request_id}
Get a team request
Description
Get a team request by its unique ID.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
request_id |
path | string | No | ||
team_id |
path | string | No |
Response 200 OK
{
"team_id": "69c0db60-f5f0-440b-93e8-ed0864a6b3fa",
"from_user_id": "c3cbdc48-63a6-4f8e-8f3c-175104c86178",
"to_user_id": "06987c4f-4ec6-4a10-8704-fa075d545ac2",
"status": null,
"admin": null,
"id": "04577b92-eafe-45a6-98cc-974a5a14ee1e",
"created_at": null,
"updated_at": null
}
Schema of the response body
{
"properties": {
"team_id": {
"type": "string",
"format": "uuid",
"title": "Team Id",
"description": "ID of the team to which the user is being invited",
"examples": [
"e2a1d6c7-d50e-4b97-945c-cd842a4e674f"
]
},
"from_user_id": {
"type": "string",
"format": "uuid",
"title": "From User Id",
"description": "ID of the user who sends the invitation",
"examples": [
"1a5d50a9-b3de-4c63-8d46-1b7ebdee179b"
]
},
"to_user_id": {
"type": "string",
"format": "uuid",
"title": "To User Id",
"description": "ID of the user who receives the invitation",
"examples": [
"3f9bfe97-2f1e-4c6d-9d60-83665e3d8be0"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestStatus"
},
{
"type": "null"
}
],
"description": "Current status of the request",
"default": "PENDING",
"examples": [
"PENDING"
]
},
"admin": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Admin",
"description": "Whether the invited user will be admin if they accept",
"default": false,
"examples": [
false
]
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier for the team request",
"examples": [
"84f8e7cd-e040-4bfb-a2dc-16d65b8d5c16"
]
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At",
"description": "Timestamp when the request was created",
"examples": [
"2025-06-12T09:23:45"
]
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated At",
"description": "Timestamp when the request was last updated",
"examples": [
"2025-06-12T10:00:00"
]
}
},
"type": "object",
"required": [
"team_id",
"from_user_id",
"to_user_id",
"id"
],
"title": "TeamRequestRead",
"description": "Response model for reading a team request."
}
Response 404 Not Found
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /teams/{team_id}/requests/{request_id}
Update a team request
Description
Update a team request by its unique ID. Users can only accept their own requests.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
request_id |
path | string | No |
Request body
{
"status": null,
"admin": null
}
Schema of the request body
{
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestStatus"
},
{
"type": "null"
}
],
"description": "Updated status of the request",
"examples": [
"ACCEPTED"
]
},
"admin": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Admin",
"description": "Change the admin privilege of the invited user",
"examples": [
true
]
}
},
"type": "object",
"title": "TeamRequestUpdate",
"description": "Request model for updating a team request's status or admin role."
}
Response 200 OK
{
"team_id": "06f96056-92c5-40aa-b424-8712bb187405",
"from_user_id": "b2f6d4ab-ea0c-4f6d-a30c-2e148b006ff5",
"to_user_id": "5f626cbd-b5cc-4047-85a4-804e74394d5b",
"status": null,
"admin": null,
"id": "8e7d2a0a-ad8c-4db0-a246-3081a35a615e",
"created_at": null,
"updated_at": null
}
Schema of the response body
{
"properties": {
"team_id": {
"type": "string",
"format": "uuid",
"title": "Team Id",
"description": "ID of the team to which the user is being invited",
"examples": [
"e2a1d6c7-d50e-4b97-945c-cd842a4e674f"
]
},
"from_user_id": {
"type": "string",
"format": "uuid",
"title": "From User Id",
"description": "ID of the user who sends the invitation",
"examples": [
"1a5d50a9-b3de-4c63-8d46-1b7ebdee179b"
]
},
"to_user_id": {
"type": "string",
"format": "uuid",
"title": "To User Id",
"description": "ID of the user who receives the invitation",
"examples": [
"3f9bfe97-2f1e-4c6d-9d60-83665e3d8be0"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestStatus"
},
{
"type": "null"
}
],
"description": "Current status of the request",
"default": "PENDING",
"examples": [
"PENDING"
]
},
"admin": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Admin",
"description": "Whether the invited user will be admin if they accept",
"default": false,
"examples": [
false
]
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "Unique identifier for the team request",
"examples": [
"84f8e7cd-e040-4bfb-a2dc-16d65b8d5c16"
]
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At",
"description": "Timestamp when the request was created",
"examples": [
"2025-06-12T09:23:45"
]
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated At",
"description": "Timestamp when the request was last updated",
"examples": [
"2025-06-12T10:00:00"
]
}
},
"type": "object",
"required": [
"team_id",
"from_user_id",
"to_user_id",
"id"
],
"title": "TeamRequestRead",
"description": "Response model for reading a team request."
}
Response 404 Not Found
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
env_request
GET /envs/requests/me
List user env requests with details
Description
List all requests addressed to the current user with user and env details.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
page |
query | integer | 1 | No | |
size |
query | integer | 50 | No |
Response 200 OK
{
"items": [
{
"id": "0b7a0aec-c4b7-4fdd-995e-331b343c185f",
"env_id": "40e02bb7-c3f6-439f-9f01-3c597ed3c385",
"env_name": "string",
"from_user_id": "493d562a-6953-4807-b0bb-0ead8eb1a8a8",
"from_user_email": "string",
"to_user_id": "d6170c77-689a-419c-ae26-1fa6374ff2cb",
"to_user_email": "string",
"status": "PENDING",
"admin": true,
"created_at": null,
"updated_at": null
}
],
"total": null,
"page": null,
"size": null,
"pages": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/EnvRequestListAsMember"
},
"type": "array",
"title": "Items"
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Total"
},
"page": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Page"
},
"size": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Size"
},
"pages": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size"
],
"title": "Page[EnvRequestListAsMember]"
}
Response 404 Not Found
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /envs/{env_id}/requests
List env requests
Description
List all requests for a specific environment. Only env admins can access this.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
env_id |
path | string | No | ||
page |
query | integer | 1 | No | |
size |
query | integer | 50 | No |
Response 200 OK
{
"items": [
{
"id": "69a647d1-b463-43e4-9f9e-c1745460c9c4",
"env_id": "adaba51c-0ca9-49bd-b155-bd0913729d9b",
"from_user_id": "fba01ff1-3a7a-4561-82f4-e584a56561cc",
"to_user_id": "30a37dff-6608-4c9c-b16f-00865e181731",
"to_user_email": "string",
"status": "PENDING",
"admin": true,
"created_at": null,
"updated_at": null
}
],
"total": null,
"page": null,
"size": null,
"pages": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/EnvRequestListAsAdmin"
},
"type": "array",
"title": "Items"
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Total"
},
"page": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Page"
},
"size": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Size"
},
"pages": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size"
],
"title": "Page[EnvRequestListAsAdmin]"
}
Response 404 Not Found
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /envs/{env_id}/requests
Register an env request
Description
Register a new env request. Only env admins can send requests.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
env_id |
path | string | No |
Request body
{
"env_id": "83c352e3-fffc-4fc4-97c2-954d1e376365",
"from_user_id": "52529a88-ea72-4e5a-8423-0afed60b0ca6",
"to_user_email": "string",
"status": null,
"admin": null
}
Schema of the request body
{
"properties": {
"env_id": {
"type": "string",
"format": "uuid",
"title": "Env Id",
"description": "ID of the environment to which the user is being invited",
"examples": [
"e2a1d6c7-d50e-4b97-945c-cd842a4e674f"
]
},
"from_user_id": {
"type": "string",
"format": "uuid",
"title": "From User Id",
"description": "ID of the user who sends the invitation",
"examples": [
"1a5d50a9-b3de-4c63-8d46-1b7ebdee179b"
]
},
"to_user_email": {
"type": "string",
"title": "To User Email",
"description": "Email of the user who receives the invitation",
"examples": [
"[email protected]"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestStatus"
},
{
"type": "null"
}
],
"description": "Current status of the request",
"default": "PENDING",
"examples": [
"PENDING"
]
},
"admin": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Admin",
"description": "Whether the invited user will be admin if they accept",
"default": false,
"examples": [
false
]
}
},
"type": "object",
"required": [
"env_id",
"from_user_id",
"to_user_email"
],
"title": "EnvRequestCreate",
"description": "Request model for creating an env invitation request."
}
Response 201 Created
{
"id": "cbf48f3d-a22d-42be-9ad6-6fa160f00482",
"env_id": "32bafc91-6edf-40d0-98af-e661dc6e49d5",
"from_user_id": "d4e6660a-c231-410d-bbcd-832a1df824f8",
"to_user_id": "f49c08a5-838b-4ce9-bfcc-e9cd1498324d",
"status": "PENDING",
"admin": true,
"created_at": null,
"updated_at": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "ID of the env request"
},
"env_id": {
"type": "string",
"format": "uuid",
"title": "Env Id",
"description": "ID of the target environment"
},
"from_user_id": {
"type": "string",
"format": "uuid",
"title": "From User Id",
"description": "ID of the user who created the request"
},
"to_user_id": {
"type": "string",
"format": "uuid",
"title": "To User Id",
"description": "ID of the invited user"
},
"status": {
"$ref": "#/components/schemas/RequestStatus",
"description": "Current request status"
},
"admin": {
"type": "boolean",
"title": "Admin",
"description": "Whether the invited user is granted admin rights"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At",
"description": "Creation timestamp"
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated At",
"description": "Last update timestamp"
}
},
"type": "object",
"required": [
"id",
"env_id",
"from_user_id",
"to_user_id",
"status",
"admin"
],
"title": "EnvRequestRead",
"description": "Response model for reading a single env request."
}
Response 404 Not Found
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /envs/requests/{request_id}
Get env request
Description
Get a specific env request by ID.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
request_id |
path | string | No |
Response 200 OK
{
"id": "73500efd-832e-48e9-86e9-14caff722355",
"env_id": "ea459a81-e3c8-4175-b3f9-b5a05d38a084",
"from_user_id": "7507e1ea-fbd4-4d5e-8774-422eff00a791",
"to_user_id": "b225b6ea-3bec-4662-9e1f-4ae22cb4023a",
"status": "PENDING",
"admin": true,
"created_at": null,
"updated_at": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "ID of the env request"
},
"env_id": {
"type": "string",
"format": "uuid",
"title": "Env Id",
"description": "ID of the target environment"
},
"from_user_id": {
"type": "string",
"format": "uuid",
"title": "From User Id",
"description": "ID of the user who created the request"
},
"to_user_id": {
"type": "string",
"format": "uuid",
"title": "To User Id",
"description": "ID of the invited user"
},
"status": {
"$ref": "#/components/schemas/RequestStatus",
"description": "Current request status"
},
"admin": {
"type": "boolean",
"title": "Admin",
"description": "Whether the invited user is granted admin rights"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At",
"description": "Creation timestamp"
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated At",
"description": "Last update timestamp"
}
},
"type": "object",
"required": [
"id",
"env_id",
"from_user_id",
"to_user_id",
"status",
"admin"
],
"title": "EnvRequestRead",
"description": "Response model for reading a single env request."
}
Response 404 Not Found
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PATCH /envs/requests/{request_id}
Update env request
Description
Update an env request (accept/decline).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
request_id |
path | string | No |
Request body
{
"status": null,
"admin": null
}
Schema of the request body
{
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/RequestStatus"
},
{
"type": "null"
}
],
"description": "New status for the request",
"examples": [
"ACCEPTED",
"DECLINED"
]
},
"admin": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Admin",
"description": "Whether the invited user will be admin if they accept",
"examples": [
true
]
}
},
"type": "object",
"title": "EnvRequestUpdate",
"description": "Request model for updating an env request."
}
Response 200 OK
{
"id": "555d9d63-7668-4642-affb-2791a322caa1",
"env_id": "e6c873ab-6fcd-4cda-92c4-a517d3e647ab",
"from_user_id": "578a043d-459e-4e04-a9a0-036faa3ee0f0",
"to_user_id": "73165ddc-da56-4b5e-b830-7dd7ed8b7f7a",
"status": "PENDING",
"admin": true,
"created_at": null,
"updated_at": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "ID of the env request"
},
"env_id": {
"type": "string",
"format": "uuid",
"title": "Env Id",
"description": "ID of the target environment"
},
"from_user_id": {
"type": "string",
"format": "uuid",
"title": "From User Id",
"description": "ID of the user who created the request"
},
"to_user_id": {
"type": "string",
"format": "uuid",
"title": "To User Id",
"description": "ID of the invited user"
},
"status": {
"$ref": "#/components/schemas/RequestStatus",
"description": "Current request status"
},
"admin": {
"type": "boolean",
"title": "Admin",
"description": "Whether the invited user is granted admin rights"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At",
"description": "Creation timestamp"
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated At",
"description": "Last update timestamp"
}
},
"type": "object",
"required": [
"id",
"env_id",
"from_user_id",
"to_user_id",
"status",
"admin"
],
"title": "EnvRequestRead",
"description": "Response model for reading a single env request."
}
Response 404 Not Found
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /envs/requests/{request_id}
Delete env request
Description
Delete an env request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
request_id |
path | string | No |
Response 204 No Content
Response 404 Not Found
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
user-logs
GET /user-logs
User Logs:List
Description
List user logs with filtering options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
action |
query | None | No | Filter by action type (login, logout, etc.) | |
from_date |
query | None | No | Start date for filtering logs (ISO 8601 format). | |
page |
query | integer | 1 | No | |
size |
query | integer | 50 | No | |
to_date |
query | None | No | End date for filtering logs (ISO 8601 format). | |
user_id |
query | None | No | Filter logs for a specific user by user ID. | |
user_type |
query | None | No | Filter by user type (real_user or system). |
Response 200 OK
{
"items": [
{
"id": "fa352afe-9c2a-4ff7-a39f-d76cede9ddce",
"timestamp": "2022-04-13T15:42:05.901Z",
"user_type": "real_user",
"action": "login",
"user_id": null,
"user_email": null
}
],
"total": null,
"page": null,
"size": null,
"pages": null
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/UserLogList"
},
"type": "array",
"title": "Items"
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Total"
},
"page": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Page"
},
"size": {
"anyOf": [
{
"type": "integer",
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Size"
},
"pages": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size"
],
"title": "Page[UserLogList]"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
saml
GET /saml/is_activated
Is Activated
Description
Saml is activated route.
Response 200 OK
Schema of the response body
{
"type": "object",
"title": "Response Is Activated Saml Is Activated Get"
}
GET /saml/login
Saml Login
Description
Saml login route.
Response 200 OK
Schema of the response body
GET /saml/metadata
Metadata
Description
Saml metadata route.
Response 200 OK
Schema of the response body
POST /saml/callback
Saml Login Callback
Description
Saml login callback route.
Response 200 OK
Schema of the response body
connectors
GET /connectors/source-config
List Source Config
Description
List all source configurations.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
[
{
"id": "6728d809-dd52-491d-a4fa-c690b87a8df0",
"name": "string",
"type": "job_smt",
"config": {}
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/SourceConfigRead"
},
"type": "array",
"title": "Response List Source Config Connectors Source Config Get"
}
GET /connectors/target-config
List Target Config
Description
List all target configurations.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Response 200 OK
[
{
"id": "96eeff82-163e-47c2-94ad-d1b16a62bee0",
"name": "string",
"type": "job_smt",
"config": {}
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/TargetConfigRead"
},
"type": "array",
"title": "Response List Target Config Connectors Target Config Get"
}
Schemas
ActionType
Type: string
BearerResponse
| Name | Type |
|---|---|
access_token |
string |
token_type |
string |
Body_auth_jwt_login_auth_jwt_login_post
| Name | Type |
|---|---|
client_id |
|
client_secret |
|
grant_type |
|
password |
string |
scope |
string |
username |
string |
Body_job_smt_process_dict_mover_smt_process_dict_mover_post
| Name | Type |
|---|---|
config |
KeysConfiguration |
message |
Body_job_smt_process_encryption_smt_process_encryption_post
| Name | Type |
|---|---|
config |
EncryptConfiguration |
message |
Body_job_smt_process_filtering_smt_process_filtering_post
| Name | Type |
|---|---|
config |
FilteringConfiguration |
message |
Body_job_smt_process_hash_smt_process_hash_post
| Name | Type |
|---|---|
config |
HashConfig |
message |
Body_job_smt_process_key_filter_smt_process_key_filter_post
| Name | Type |
|---|---|
config |
KeysConfiguration |
message |
Body_job_smt_process_key_mover_smt_process_key_mover_post
| Name | Type |
|---|---|
config |
Array<KeyMoverConfig> |
message |
Body_job_smt_process_mapper_smt_process_mapper_post
| Name | Type |
|---|---|
config |
Array<MapperTableConfig> |
message |
Body_job_smt_process_splitter_smt_process_splitter_post
| Name | Type |
|---|---|
config |
SplitterConfiguration |
message |
Body_job_smt_process_stringify_key_smt_process_stringify_key_post
| Name | Type |
|---|---|
config |
KeysConfiguration |
message |
Body_job_smt_process_unenvelope_smt_process_unenvelope_post
| Name | Type |
|---|---|
config |
KeyConfiguration |
message |
Body_reset_forgot_password_auth_forgot_password_post
| Name | Type |
|---|---|
email |
string(email) |
Body_reset_reset_password_auth_reset_password_post
| Name | Type |
|---|---|
password |
string |
token |
string |
Body_verify_request_token_auth_request_verify_token_post
| Name | Type |
|---|---|
email |
string(email) |
Body_verify_verify_auth_verify_post
| Name | Type |
|---|---|
token |
string |
BrokerCheckStatus
| Name | Type |
|---|---|
status |
boolean |
BrokerConfiguration
| Name | Type |
|---|---|
bootstrap_server |
string |
ca_cert |
string |
sasl_mechanism |
string |
sasl_password |
string |
sasl_username |
string |
security_protocol |
string |
ConnectorType
Type: string
CredentialsResponse
| Name | Type |
|---|---|
is_success |
boolean |
message |
string |
Debug
| Name | Type |
|---|---|
header |
DictMoverFunctionConfiguration
| Name | Type |
|---|---|
function_config |
KeysConfiguration |
function_type |
string |
EmptyFunctionConfiguration
| Name | Type |
|---|---|
function_config |
null |
function_type |
null |
EncryptConfiguration
| Name | Type |
|---|---|
encrypt_key |
string |
paths |
Array<string> |
EncryptFunctionConfiguration
| Name | Type |
|---|---|
function_config |
EncryptConfiguration |
function_type |
string |
EnvCreate
| Name | Type |
|---|---|
name |
string |
retention_configuration |
|
use_retention |
boolean |
EnvExport
| Name | Type |
|---|---|
id |
string(uuid) |
name |
string |
retention_configuration |
|
use_retention |
boolean |
EnvList
| Name | Type |
|---|---|
id |
string(uuid) |
name |
string |
EnvMemberExport
| Name | Type |
|---|---|
admin |
boolean |
env_id |
string(uuid) |
user_id |
string(uuid) |
EnvMemberList
| Name | Type |
|---|---|
admin |
boolean |
email |
string |
id |
string(uuid) |
user_id |
string(uuid) |
EnvMemberRead
| Name | Type |
|---|---|
admin |
boolean |
env_id |
string(uuid) |
id |
string(uuid) |
user_id |
string(uuid) |
EnvRead
| Name | Type |
|---|---|
id |
string(uuid) |
name |
string |
retention_configuration |
|
use_retention |
boolean |
EnvRequestCreate
| Name | Type |
|---|---|
admin |
|
env_id |
string(uuid) |
from_user_id |
string(uuid) |
status |
|
to_user_email |
string |
EnvRequestListAsAdmin
| Name | Type |
|---|---|
admin |
boolean |
created_at |
|
env_id |
string(uuid) |
from_user_id |
string(uuid) |
id |
string(uuid) |
status |
RequestStatus |
to_user_email |
string |
to_user_id |
string(uuid) |
updated_at |
EnvRequestListAsMember
| Name | Type |
|---|---|
admin |
boolean |
created_at |
|
env_id |
string(uuid) |
env_name |
string |
from_user_email |
string |
from_user_id |
string(uuid) |
id |
string(uuid) |
status |
RequestStatus |
to_user_email |
string |
to_user_id |
string(uuid) |
updated_at |
EnvRequestRead
| Name | Type |
|---|---|
admin |
boolean |
created_at |
|
env_id |
string(uuid) |
from_user_id |
string(uuid) |
id |
string(uuid) |
status |
RequestStatus |
to_user_id |
string(uuid) |
updated_at |
EnvRequestUpdate
| Name | Type |
|---|---|
admin |
|
status |
EnvUpdate
| Name | Type |
|---|---|
name |
|
retention_configuration |
|
use_retention |
ErrorModel
| Name | Type |
|---|---|
detail |
ExportData-Input
| Name | Type |
|---|---|
env_members |
Array<EnvMemberExport> |
envs |
Array<EnvExport> |
team_members |
Array<TeamMemberExport> |
teams |
Array<TeamExport> |
users |
Array<UserExport> |
ExportData-Output
| Name | Type |
|---|---|
env_members |
Array<EnvMemberExport> |
envs |
Array<EnvExport> |
team_members |
Array<TeamMemberExport> |
teams |
Array<TeamExport> |
users |
Array<UserExport> |
FilteringConfiguration
| Name | Type |
|---|---|
key |
string |
operator |
string |
value |
string |
FilteringFunctionConfiguration
| Name | Type |
|---|---|
function_config |
FilteringConfiguration |
function_type |
string |
FlattenerFunctionConfiguration
| Name | Type |
|---|---|
function_config |
null |
function_type |
string |
HashConfig
| Name | Type |
|---|---|
hash_type |
string |
paths |
Array<string> |
HashFunctionConfiguration
| Name | Type |
|---|---|
function_config |
HashConfig |
function_type |
string |
HealthCheck
| Name | Type |
|---|---|
status |
string |
HTTPValidationError
| Name | Type |
|---|---|
detail |
Array<ValidationError> |
KafkaSourceCredentials
| Name | Type |
|---|---|
bootstrap_servers |
string |
consumer_group_id |
|
include_metadata |
|
sasl_mechanism |
string |
sasl_password |
string |
sasl_username |
string |
security_protocol |
string |
topic |
string |
KeyConfiguration
| Name | Type |
|---|---|
key |
string |
KeyFilterFunctionConfiguration
| Name | Type |
|---|---|
function_config |
KeysConfiguration |
function_type |
string |
KeyMoverConfig
| Name | Type |
|---|---|
key |
string |
key_path |
string |
KeyMoverFunctionConfiguration
| Name | Type |
|---|---|
function_config |
Array<KeyMoverConfig> |
function_type |
string |
KeyNormalizerFunctionConfiguration
| Name | Type |
|---|---|
function_config |
null |
function_type |
string |
KeysConfiguration
| Name | Type |
|---|---|
keys |
Array<string> |
MapperColumnConfig
| Name | Type |
|---|---|
key |
string |
nullable |
boolean |
path |
string |
static |
string |
MapperFunctionConfiguration-Input
| Name | Type |
|---|---|
function_config |
Array<MapperTableConfig> |
function_type |
string |
MapperFunctionConfiguration-Output
| Name | Type |
|---|---|
function_config |
Array<MapperTableConfig> |
function_type |
string |
MapperTableConfig
| Name | Type |
|---|---|
fields |
Array<MapperColumnConfig> |
table_name |
string |
Messages
| Name | Type |
|---|---|
messages |
Array<> |
OracleTargetCredentials
| Name | Type |
|---|---|
database |
string |
host |
string |
password |
string |
port |
string |
server_id |
string |
server_name |
string |
user |
string |
Page_EnvList_
| Name | Type |
|---|---|
items |
Array<EnvList> |
page |
|
pages |
|
size |
|
total |
Page_EnvMemberList_
| Name | Type |
|---|---|
items |
Array<EnvMemberList> |
page |
|
pages |
|
size |
|
total |
Page_EnvRequestListAsAdmin_
| Name | Type |
|---|---|
items |
Array<EnvRequestListAsAdmin> |
page |
|
pages |
|
size |
|
total |
Page_EnvRequestListAsMember_
| Name | Type |
|---|---|
items |
Array<EnvRequestListAsMember> |
page |
|
pages |
|
size |
|
total |
Page_PipelineList_
| Name | Type |
|---|---|
items |
Array<PipelineList> |
page |
|
pages |
|
size |
|
total |
Page_PipelineStateList_
| Name | Type |
|---|---|
items |
Array<PipelineStateList> |
page |
|
pages |
|
size |
|
total |
Page_TeamList_
| Name | Type |
|---|---|
items |
Array<TeamList> |
page |
|
pages |
|
size |
|
total |
Page_TeamMemberList_
| Name | Type |
|---|---|
items |
Array<TeamMemberList> |
page |
|
pages |
|
size |
|
total |
Page_TeamRequestListAsAdmin_
| Name | Type |
|---|---|
items |
Array<TeamRequestListAsAdmin> |
page |
|
pages |
|
size |
|
total |
Page_TeamRequestListAsMember_
| Name | Type |
|---|---|
items |
Array<TeamRequestListAsMember> |
page |
|
pages |
|
size |
|
total |
Page_UserLogList_
| Name | Type |
|---|---|
items |
Array<UserLogList> |
page |
|
pages |
|
size |
|
total |
Page_UserRead_
| Name | Type |
|---|---|
items |
Array<UserRead> |
page |
|
pages |
|
size |
|
total |
PipelineConfigAsSerializer-Input
| Name | Type |
|---|---|
draft_step |
string |
smt_config |
Array<> |
smt_name |
string |
source_config |
|
source_name |
string |
source_type |
|
target_config |
|
target_name |
string |
target_type |
PipelineConfigAsSerializer-Output
| Name | Type |
|---|---|
draft_step |
string |
smt_config |
Array<> |
smt_name |
string |
source_config |
|
source_name |
string |
source_type |
|
target_config |
|
target_name |
string |
target_type |
PipelineCreate
| Name | Type |
|---|---|
json_configuration |
PipelineConfigAsSerializer-Input |
name |
string |
state |
PipelineState |
team_id |
string(uuid) |
PipelineList
| Name | Type |
|---|---|
id |
string(uuid) |
name |
string |
owner |
string |
source_name |
string |
source_type |
|
state |
PipelineState |
target_name |
string |
target_type |
|
transform |
integer |
PipelineLogs
| Name | Type |
|---|---|
count_errors |
string |
logs |
string |
status |
string |
uuid |
string |
PipelineRead
| Name | Type |
|---|---|
id |
string(uuid) |
json_configuration |
PipelineConfigAsSerializer-Output |
name |
string |
state |
PipelineState |
team_id |
string(uuid) |
team_name |
string |
PipelinesStatusCounter
| Name | Type |
|---|---|
all |
integer |
building |
integer |
draft |
integer |
error |
integer |
live |
integer |
paused |
integer |
PipelineState
Type: string
PipelineStateList
| Name | Type |
|---|---|
id |
string(uuid) |
name |
string |
state |
PipelineState |
PipelineUpdate
| Name | Type |
|---|---|
json_configuration |
|
name |
|
state |
|
team_id |
RequestStatus
Type: string
ResponseModel403
| Name | Type |
|---|---|
detail |
string |
SchemaCreate
| Name | Type |
|---|---|
schema |
string |
SchemaRead
| Name | Type |
|---|---|
id |
string(uuid) |
version |
integer |
SourceConfigRead
| Name | Type |
|---|---|
config |
|
id |
string(uuid) |
name |
string |
type |
ConnectorType |
SplitterConfiguration
| Name | Type |
|---|---|
abbreviate_len |
|
pk |
|
popsink_pk |
string |
root_table_name |
string |
SplitterFunctionConfiguration
| Name | Type |
|---|---|
function_config |
SplitterConfiguration |
function_type |
string |
StringifyFunctionConfiguration
| Name | Type |
|---|---|
function_config |
KeysConfiguration |
function_type |
string |
StringifyListFunctionConfiguration
| Name | Type |
|---|---|
function_config |
null |
function_type |
string |
TargetConfigRead
| Name | Type |
|---|---|
config |
|
id |
string(uuid) |
name |
string |
type |
ConnectorType |
TeamCreate
| Name | Type |
|---|---|
description |
string |
env_id |
|
name |
string |
TeamExport
| Name | Type |
|---|---|
description |
string |
env_id |
|
id |
string(uuid) |
name |
string |
TeamList
| Name | Type |
|---|---|
id |
string(uuid) |
name |
string |
TeamMemberBulkCreate
| Name | Type |
|---|---|
members |
Array<string(uuid)> |
owners |
Array<string(uuid)> |
TeamMemberExport
| Name | Type |
|---|---|
admin |
boolean |
team_id |
string(uuid) |
user_id |
string(uuid) |
TeamMemberList
| Name | Type |
|---|---|
admin |
boolean |
email |
string |
id |
string(uuid) |
user_id |
string(uuid) |
TeamMemberRead
| Name | Type |
|---|---|
admin |
boolean |
id |
string(uuid) |
team_id |
string(uuid) |
user_id |
string(uuid) |
TeamRead
| Name | Type |
|---|---|
description |
string |
env_id |
|
id |
string(uuid) |
name |
string |
TeamRequestCreate
| Name | Type |
|---|---|
admin |
|
from_user_id |
string(uuid) |
status |
|
team_id |
string(uuid) |
to_user_id |
string(uuid) |
TeamRequestListAsAdmin
| Name | Type |
|---|---|
admin |
boolean |
created_at |
|
from_user_id |
string(uuid) |
id |
string(uuid) |
status |
RequestStatus |
team_id |
string(uuid) |
to_user_email |
string |
to_user_id |
string(uuid) |
updated_at |
TeamRequestListAsMember
| Name | Type |
|---|---|
admin |
boolean |
created_at |
|
from_user_email |
string |
from_user_id |
string(uuid) |
id |
string(uuid) |
status |
RequestStatus |
team_id |
string(uuid) |
team_name |
string |
to_user_id |
string(uuid) |
updated_at |
TeamRequestRead
| Name | Type |
|---|---|
admin |
|
created_at |
|
from_user_id |
string(uuid) |
id |
string(uuid) |
status |
|
team_id |
string(uuid) |
to_user_id |
string(uuid) |
updated_at |
TeamRequestUpdate
| Name | Type |
|---|---|
admin |
|
status |
UnenvelopeFunctionConfiguration
| Name | Type |
|---|---|
function_config |
KeyConfiguration |
function_type |
string |
UserCreate
| Name | Type |
|---|---|
email |
string(email) |
is_active |
|
is_superuser |
boolean |
is_verified |
|
password |
string |
UserExport
| Name | Type |
|---|---|
active_env_id |
|
email |
string(email) |
id |
string(uuid) |
is_active |
boolean |
is_superuser |
boolean |
is_verified |
boolean |
UserLogList
| Name | Type |
|---|---|
action |
ActionType |
id |
string(uuid) |
timestamp |
string(date-time) |
user_email |
|
user_id |
|
user_type |
UserType |
UserPasswordChange
| Name | Type |
|---|---|
new_password |
string |
old_password |
string |
UserRead
| Name | Type |
|---|---|
active_env_id |
|
email |
string(email) |
id |
string(uuid) |
is_active |
boolean |
is_superuser |
boolean |
is_verified |
boolean |
UserSafeUpdate
| Name | Type |
|---|---|
active_env_id |
|
email |
|
is_active |
|
is_superuser |
|
is_verified |
|
password |
UserType
Type: string
ValidationError
| Name | Type |
|---|---|
loc |
Array<> |
msg |
string |
type |
string |
Security schemes
| Name | Type | Scheme | Description |
|---|---|---|---|
| OAuth2PasswordBearer | oauth2 |