{ "openapi": "3.0.0", "paths": { "/health": { "get": { "operationId": "HealthCheckController_getHealth", "parameters": [ { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthCheckResponseDto" } } } } } } }, "/api-keys": { "get": { "operationId": "ApiKeysController_findAll", "summary": "List API keys", "description": "Lists all API keys for the workspace associated with the Management API key.", "parameters": [ { "name": "type", "required": false, "in": "query", "description": "Filters by API key type.", "schema": { "enum": [ "public", "secret", "proxy" ], "type": "string" } }, { "name": "status", "required": false, "in": "query", "description": "Filters by API key status.", "schema": { "enum": [ "enabled", "disabled" ], "type": "string" } }, { "name": "environment", "required": false, "in": "query", "description": "Filters by environment ID.", "schema": { "type": "string" } }, { "name": "cursor", "required": false, "in": "query", "description": "Cursor token used for pagination. Response will contain items appearing after the given cursor.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Sets the maximum number of items contained in a single page.", "schema": { "minimum": 0, "maximum": 101, "default": 10, "type": "number" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of API keys matching the given query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeysPaginatedResponseDtoV2" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "api-keys" ] }, "post": { "operationId": "ApiKeysController_create", "summary": "Create API key", "description": "Creates an API key for the workspace associated with the Management API key. Maximum number of API keys in defined by your plan limits. If you need additional API keys, contact our support team.", "parameters": [ { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyDtoV1" } } } }, "responses": { "201": { "description": "Created API key object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/b43bcdb2376818c770704" } } } }, "400": { "description": "Error: API key can't be created due to validation errors.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "api-keys" ] } }, "/api-keys/{id}": { "get": { "operationId": "ApiKeysController_findOne", "summary": "Get API key", "description": "Fetch an API key by ID.", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "API key object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/4b43bcdb2376818c77070" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "API key with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "api-keys" ] }, "patch": { "operationId": "ApiKeysController_update", "summary": "Update API key", "description": "Updates a single API key. You can update the keys name, description, status, and rate limit. You cannot mutate the actual key itself.", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyDtoV1" } } } }, "responses": { "200": { "description": "Updated API key object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/43bcdb2376818c770704c" } } } }, "400": { "description": "Error: API key can't be updated due to validation errors.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Error: API key with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "api-keys" ] }, "delete": { "operationId": "ApiKeysController_deleteApiKey", "summary": "Delete API key", "description": "Deletes an API key with the given ID. Make sure that the key you are deleting is not used in production environment. This action is not reversible.", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Empty response indicating a successful operation." }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Error: API key with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "api-keys" ] } }, "/environments": { "get": { "operationId": "EnvironmentController_findAllV2", "summary": "List environments", "description": "Lists all environments for the workspace associated with the Management API key.", "parameters": [ { "name": "cursor", "required": false, "in": "query", "description": "Cursor token used for pagination. Response will contain items appearing after the given cursor.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Sets the maximum number of items contained in a single page.", "schema": { "minimum": 0, "maximum": 101, "default": 10, "type": "number" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of environments matching the given query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsPaginatedResponseDtoV2" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "environments" ] }, "post": { "operationId": "EnvironmentController_create", "summary": "Create an environment", "description": "Creates a new environment for the workspace associated with the Management API key. Maximum number of environments in defined by your plan limits. If you need additional environments, contact our support team.", "parameters": [ { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEnvironmentDtoV1" } } } }, "responses": { "201": { "description": "Created environment object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentApiResponseDtoV1" } } } }, "400": { "description": "Error: Environment can't be created due to validation errors.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "environments" ] } }, "/environments/{id}": { "post": { "operationId": "EnvironmentController_update", "summary": "Update an environment", "description": "Updates an environment with the given environment ID. You can update the name, description, and limit settings.", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEnvironmentDtoV1" } } } }, "responses": { "200": { "description": "Updated environment object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentApiResponseDtoV1" } } } }, "400": { "description": "Error: Environment can't be updated due to validation errors.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Error: Environment with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "environments" ] }, "delete": { "operationId": "EnvironmentController_delete", "summary": "Delete an environment", "description": "Deletes an environment with the given environment ID. You can only delete environments that don't have any active API keys associated with it.", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Empty response indicating a successful operation." }, "400": { "description": "Error: Environment can't be deleted due to validation errors.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Error: Environment with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "environments" ] } }, "/filtering-rules": { "get": { "operationId": "FilteringRulesV2Controller_findAll", "summary": "List filtering rules", "description": "Lists all filtering rules for the workspace associated with the Management API key. Supports filtering by environment, status, and name.", "parameters": [ { "name": "environment", "required": false, "in": "query", "description": "Filters by environment ID.", "schema": { "type": "string" } }, { "name": "status", "required": false, "in": "query", "description": "Filters by rule status.", "schema": { "enum": [ "enabled", "disabled" ], "type": "string" } }, { "name": "name", "required": false, "in": "query", "description": "Filters by rule name (partial match).", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of filtering rules matching the given query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/b2376818c770704cb8ff0" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "filtering-rules" ] }, "post": { "operationId": "FilteringRulesV2Controller_create", "summary": "Create filtering rule", "description": "Creates a new filtering rule. The rule will be evaluated in order based on the placement parameter. If no placement is specified, the rule is added to the end.", "parameters": [ { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseFilteringRuleDto" } } } }, "responses": { "201": { "description": "Created filtering rule object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/376818c770704cb8ff0d6" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "filtering-rules" ] } }, "/filtering-rules/v2-migration": { "get": { "operationId": "FilteringRulesV2Controller_migrateV2", "summary": "Migrate filtering rules from V1 to V2", "description": "Migrates filtering rules from V1 to V2 format. Use the rollback query parameter to rollback to V1 instead.", "parameters": [ { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Migration or rollback completed successfully." }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "filtering-rules" ] } }, "/filtering-rules/{id}": { "get": { "operationId": "FilteringRulesV2Controller_findOne", "summary": "Retrieve filtering rule", "description": "Retrieves a single filtering rule by ID.", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Filtering rule object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/2376818c770704cb8ff0d" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Error: Filtering rule with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "filtering-rules" ] }, "delete": { "operationId": "FilteringRulesV2Controller_delete", "summary": "Delete filtering rule", "description": "Deletes a filtering rule with the given ID. Make sure the rule is not critical for your production environment. This action is not reversible.", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Empty response indicating a successful operation." }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Error: Filtering rule with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "filtering-rules" ] }, "post": { "operationId": "FilteringRulesV2Controller_update", "summary": "Update filtering rule", "description": "Updates an existing filtering rule. Only provided fields will be updated.", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFilteringRuleDtoV2" } } } }, "responses": { "200": { "description": "Updated filtering rule object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/818c770704cb8ff0d6ec8" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Error: Filtering rule with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "filtering-rules" ] } }, "/filtering-rules/bulk": { "post": { "operationId": "FilteringRulesV2Controller_bulk", "summary": "Bulk create/update filtering rules", "description": "Creates or updates multiple filtering rules at once. In \"merge\" mode (default), rules with IDs are updated and rules without IDs are created. In \"overwrite\" mode, all existing rules for the given environment are deleted and replaced with the provided rules.", "parameters": [ { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkFilteringRulesDtoV2" } } } }, "responses": { "200": { "description": "List of created/updated filtering rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/76818c770704cb8ff0d6e" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "filtering-rules" ] } }, "/filtering-rules/test": { "post": { "operationId": "FilteringRulesV2Controller_test", "summary": "Test filtering rules", "description": "Tests filtering rules against a specified request ID or custom event payload. You can provide an existing request ID (up to 3 months old) or a custom JSON payload. Optionally, you can provide custom rules to test instead of using existing rules.", "parameters": [ { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestFilteringRulesDtoV2" } } } }, "responses": { "200": { "description": "Test results showing which rule was triggered (if any) and the resulting action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/6818c770704cb8ff0d6ec" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "filtering-rules" ] } }, "/webhooks/{webhookId}/rules": { "get": { "operationId": "WebhookRulesController_findAll", "summary": "List webhook rules", "description": "Lists all rules for a webhook belonging to the workspace associated with the Management API key.", "parameters": [ { "name": "webhookId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of webhook rules matching the given query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/18c770704cb8ff0d6ec88" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Error: Webhook with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "webhook-rules" ] }, "post": { "operationId": "WebhookRulesController_create", "summary": "Create webhook rule", "description": "Creates a rule for a webhook belonging to the workspace associated with the Management API key. Maximum number of API keys in defined by your plan limits. If you need additional API keys, contact our support team.", "parameters": [ { "name": "webhookId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRuleDtoV1" } } } }, "responses": { "201": { "description": "Created webhook rule object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/8c770704cb8ff0d6ec88f" } } } }, "400": { "description": "Error: Webhook rule can't be created due to validation errors.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Error: Webhook with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "webhook-rules" ] } }, "/webhooks/{webhookId}/rules/{id}": { "delete": { "operationId": "WebhookRulesController_delete", "summary": "Delete webhook rule", "description": "Deletes a webhook rule with the given ID. Make sure that the key you are deleting is not used in production environment. This action is not reversible.", "parameters": [ { "name": "webhookId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Empty response indicating a successful operation." }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Error: Webhook or webhook rule with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "webhook-rules" ] } }, "/webhooks": { "get": { "operationId": "WebhooksController_findAllV2", "summary": "List webhooks", "description": "Lists all webhooks associated to the Management API key, optionally filtered by status.", "parameters": [ { "name": "status", "required": false, "in": "query", "description": "Filters by webhook status.", "schema": { "enum": [ "enabled", "disabled" ], "type": "string" } }, { "name": "environment", "required": false, "in": "query", "description": "Filters by webhook environment ID.", "schema": { "type": "string" } }, { "name": "cursor", "required": false, "in": "query", "description": "Cursor token used for pagination. Response will contain items appearing after the given cursor.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Sets the maximum number of items contained in a single page.", "schema": { "minimum": 0, "maximum": 101, "default": 10, "type": "number" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of webhooks matching the given query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPaginatedListResponseDtoV2" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Unauthorized. API key is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Webhook does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "webhooks" ] }, "post": { "operationId": "WebhooksController_create", "summary": "Create webhook", "description": "Creates a new webhook in the workspace associated with the Management API key.\nWebhook needs to be verified before it will start sending identification events to your server. See webhook verification.\nIf webhook signatures are enabled (enterprise only), signing key will be visible in the response after creation. When fetching webhooks after creation, signing key will not be visible!\nSee webhooks documentation for more details.\nWhen specifying an environment during creation, webhook should be assigned to the given environment. Setting environment to null creates a global webhook.", "parameters": [ { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookDtoV1" } } } }, "responses": { "201": { "description": "Webhook created, but needs to be verified before it's active.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Unauthorized. API key is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Webhook does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "webhooks" ] } }, "/webhooks/{id}": { "get": { "operationId": "WebhooksController_findOne", "summary": "Get webhook by ID", "description": "Fetch a specific webhook by ID.", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Webhook ID", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Webhook object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Unauthorized. API key is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Webhook does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "webhooks" ] }, "patch": { "operationId": "WebhooksController_update", "summary": "Update webhook", "description": "Updates the webhook with the given ID. You can update the name, description, status, URL, and set basic authentication.\nChanging the URL will require this webhook to be verified again.\nChanging the status will disable/enable sending of identification events to your webhook.", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Webhook ID", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookDtoV1" } } } }, "responses": { "200": { "description": "Webhook updated. Changes will take effect in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Unauthorized. API key is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Webhook does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "webhooks" ] }, "delete": { "operationId": "WebhooksController_remove", "summary": "Delete webhook", "description": "Deletes the webhook with the given ID. This action is not reversible. Changes will take affect in a few minutes.", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Webhook ID", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Empty response indicating a successful operation." }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Unauthorized. API key is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Webhook does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "webhooks" ] } }, "/webhooks/{id}/verification": { "post": { "operationId": "WebhooksController_verify", "summary": "Verify webhook", "description": "Send a test event in order to verify your webhook endpoint, it needs to respond with HTTP 200 to be verified.\nWebhook needs to be verified before it will receive identification events.", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Webhook ID", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Webhook verification process initiated. Make sure webhook is active in order to receive identification events.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } } }, "400": { "description": "Bad request. Webhook is already verified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "401": { "description": "Unauthorized. API key is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Webhook does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "webhooks" ] } }, "/encryption-keys": { "get": { "operationId": "EncryptionKeysController_findAll", "summary": "List encryption keys", "description": "Lists all encryption keys for the workspace associated with the Management API key.", "parameters": [ { "name": "status", "required": false, "in": "query", "description": "Filters by encryption key status.", "schema": { "enum": [ "enabled", "disabled" ], "type": "string" } }, { "name": "environment", "required": false, "in": "query", "description": "Filters by environment ID.", "schema": { "type": "string" } }, { "name": "cursor", "required": false, "in": "query", "description": "Cursor token used for pagination. Response will contain items appearing after the given cursor.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Sets the maximum number of items contained in a single page.", "schema": { "minimum": 0, "maximum": 101, "default": 10, "type": "number" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of encryption keys matching the given query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EncryptionKeysPaginatedResponseDtoV1" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "encryption-keys" ] } }, "/encryption-keys/{id}": { "get": { "operationId": "EncryptionKeysController_findOne", "summary": "Get encryption key", "description": "Fetch an encryption key by ID.", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Encryption key object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/770704cb8ff0d6ec88f18" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Encryption key with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "encryption-keys" ] }, "patch": { "operationId": "EncryptionKeysController_update", "summary": "Update encryption key", "description": "Updates a single encryption key. You can update the keys name, description, and status. You cannot mutate the actual key itself.", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEncryptionKeyDtoV1" } } } }, "responses": { "200": { "description": "Updated encryption key object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/704cb8ff0d6ec88f1897f" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Error: Encryption key with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "encryption-keys" ] } }, "/encryption-keys/{id}/rotate": { "post": { "operationId": "EncryptionKeysController_rotate", "summary": "Rotate encryption key", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Encryption key object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/70704cb8ff0d6ec88f189" } } } }, "400": { "description": "Error: Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Encryption key with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "encryption-keys" ] } }, "/encryption-keys/{id}/revert": { "post": { "operationId": "EncryptionKeysController_revert", "summary": "Revert encryption key rotation", "description": "Reverts the last encryption key rotation.", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-Version", "in": "header", "description": "Management API version.", "example": "2025-11-20", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Encryption key object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/0704cb8ff0d6ec88f1897" } } } }, "400": { "description": "Error: No rotation to revert.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "401": { "description": "Error: Invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "403": { "description": "Forbidden. Insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "404": { "description": "Encryption key with the given ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } }, "422": { "description": "Error: Payload parameters are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationApiExceptionDto" } } } }, "429": { "description": "Error: API key has exceeded its rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiExceptionDto" } } } } }, "tags": [ "encryption-keys" ] } } }, "info": { "title": "Management API", "description": "Managment API allows you to manage your Fingerprint account and applications programmatically from a server environment.", "version": "2025-11-20", "contact": {} }, "tags": [], "servers": [ { "url": "https://management-api.fpjs.io" } ], "components": { "securitySchemes": { "Management-API-key": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http" } }, "schemas": { "HealthCheckResponseDto": { "type": "object", "properties": {} }, "ApiKeyResponseDtoV1": { "type": "object", "properties": { "id": { "type": "string", "description": "Auto-generated ID for an API key", "example": "tok_No3jUysGLCDuqB3RnCVf1weo" }, "name": { "type": "string", "description": "API key name", "example": "My Public Key" }, "description": { "type": "string", "description": "API key description", "example": "Description for my public key" }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "description": "API key status, indicates if an API keys is enabled or disabled.", "example": "enabled" }, "environment": { "type": "object", "description": "ID of an environment the API key belongs to.", "example": "ae_rrETjdWcfqI6AFsk", "nullable": true }, "type": { "type": "string", "enum": [ "public", "secret", "proxy" ], "description": "Type of an API key.", "example": "public" }, "token": { "type": "string", "description": "Value of an API key. This field is immutable, and for secret keys it's only visible upon creation.", "example": "eWDrrpGGLjDQW0LBA0Wj" }, "rateLimit": { "type": "number", "description": "Current limit in requests-per-second for the API key.", "example": 5 }, "createdAt": { "format": "date-time", "type": "string", "description": "Date when API key was created.", "example": "2024-05-31T01:24:39.506Z" }, "disabledAt": { "format": "date-time", "type": "string", "description": "Date when API key was disabled.", "example": null } }, "required": [ "id", "name", "status", "environment", "type", "rateLimit", "createdAt" ] }, "PaginationData": { "type": "object", "properties": { "nextCursor": { "type": "string", "nullable": true, "description": "Cursor token to be used to get the next page of results.", "example": "eyJrZXlzIjpbImlkIl0sInZhbHVlcyI6WyJhZV9JRVdWQVhrQURyN3BiNFYzI" }, "prevCursor": { "type": "string", "nullable": true, "description": "Cursor token used to get the previous page of results.", "example": null } }, "required": [ "nextCursor", "prevCursor" ] }, "PaginationMetadata": { "type": "object", "properties": { "pagination": { "description": "Object containing pagination metadata.", "allOf": [ { "$ref": "#/components/schemas/PaginationData" } ] } }, "required": [ "pagination" ] }, "ApiKeysPaginatedResponseDtoV1": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyResponseDtoV1" } }, "metadata": { "$ref": "#/components/schemas/PaginationMetadata" } }, "required": [ "data", "metadata" ] }, "BaseApiExceptionDto": { "type": "object", "properties": { "message": { "type": "string", "description": "Verbal description of the error." }, "code": { "type": "string", "description": "Error code." } }, "required": [ "message", "code" ] }, "ApiExceptionDto": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/BaseApiExceptionDto" } }, "required": [ "error" ] }, "3d84b43bcdb2376818c77": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApiKeyResponseDtoV1" } }, "required": [ "data" ] }, "CreateApiKeyDtoV1": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "public", "secret", "proxy" ], "description": "Type of an API key." }, "name": { "type": "string", "description": "Name of an API key.", "maxLength": 255, "minLength": 3 }, "description": { "type": "string", "description": "Description for an API key.", "maxLength": 255, "minLength": 3 }, "environment": { "type": "string", "description": "Environment in which to create an API key. If omitted for proxy or secret API keys, the key will be scoped to the workspace. If omitted for other types of keys, the API key will be created in the default environment." } }, "required": [ "type", "name" ] }, "d84b43bcdb2376818c770": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApiKeyResponseDtoV1" } }, "required": [ "data" ] }, "BaseValidationApiExceptionViolationDto": { "type": "object", "properties": { "property": { "type": "string", "description": "Property that has failed validation." }, "message": { "type": "string", "description": "Description of the violation." } }, "required": [ "property", "message" ] }, "BaseValidationApiExceptionDto": { "type": "object", "properties": { "message": { "type": "string", "description": "Verbal description of the error." }, "code": { "type": "string", "description": "Error code." }, "violations": { "description": "List of validation violations.", "type": "array", "items": { "$ref": "#/components/schemas/BaseValidationApiExceptionViolationDto" } } }, "required": [ "message", "code" ] }, "ValidationApiExceptionDto": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/BaseValidationApiExceptionDto" } }, "required": [ "error" ] }, "UpdateApiKeyDtoV1": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of an API key.", "maxLength": 255, "minLength": 3 }, "description": { "type": "string", "description": "Description for an API key.", "maxLength": 255, "minLength": 3 }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "description": "Set API key status. Use to enable or disable an API key." }, "rate_limit": { "type": "number", "description": "Set rate limit for an API key. Value is in request-per-second.", "minimum": 0.1 } } }, "84b43bcdb2376818c7707": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApiKeyResponseDtoV1" } }, "required": [ "data" ] }, "ApiKeyResponseDtoV2": { "type": "object", "properties": { "id": { "type": "string", "description": "Auto-generated ID for an API key", "example": "tok_No3jUysGLCDuqB3RnCVf1weo" }, "name": { "type": "string", "description": "API key name", "example": "My Public Key" }, "description": { "type": "string", "description": "API key description", "example": "Description for my public key" }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "description": "API key status, indicates if an API keys is enabled or disabled.", "example": "enabled" }, "environment": { "type": "object", "description": "ID of an environment the API key belongs to.", "example": "ae_rrETjdWcfqI6AFsk", "nullable": true }, "type": { "type": "string", "enum": [ "public", "secret", "proxy" ], "description": "Type of an API key.", "example": "public" }, "token": { "type": "string", "description": "Value of an API key. This field is immutable, and for secret keys it's only visible upon creation.", "example": "eWDrrpGGLjDQW0LBA0Wj" }, "rate_limit": { "type": "number", "description": "Current limit in requests-per-second for the API key.", "example": 5 }, "created_at": { "format": "date-time", "type": "string", "description": "Date when API key was created.", "example": "2024-05-31T01:24:39.506Z" }, "disabled_at": { "format": "date-time", "type": "string", "description": "Date when API key was disabled.", "example": null } }, "required": [ "id", "name", "status", "environment", "type", "rate_limit", "created_at" ] }, "PaginationDataV2": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true, "description": "Cursor token to be used to get the next page of results.", "example": "eyJrZXlzIjpbImlkIl0sInZhbHVlcyI6WyJhZV9JRVdWQVhrQURyN3BiNFYzI" }, "prev_cursor": { "type": "string", "nullable": true, "description": "Cursor token used to get the previous page of results.", "example": null } }, "required": [ "next_cursor", "prev_cursor" ] }, "PaginationMetadataV2": { "type": "object", "properties": { "pagination": { "description": "Object containing pagination metadata.", "allOf": [ { "$ref": "#/components/schemas/PaginationDataV2" } ] } }, "required": [ "pagination" ] }, "ApiKeysPaginatedResponseDtoV2": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyResponseDtoV2" } }, "metadata": { "$ref": "#/components/schemas/PaginationMetadataV2" } }, "required": [ "data", "metadata" ] }, "4b43bcdb2376818c77070": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApiKeyResponseDtoV2" } }, "required": [ "data" ] }, "b43bcdb2376818c770704": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApiKeyResponseDtoV2" } }, "required": [ "data" ] }, "43bcdb2376818c770704c": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApiKeyResponseDtoV2" } }, "required": [ "data" ] }, "EnvironmentResponseDtoV1": { "type": "object", "properties": { "id": { "type": "string", "description": "Auto-generated ID for an environment", "example": "ae_rrETjdWcfqI6AFsk" }, "name": { "type": "string", "description": "Environment name", "example": "Default environment" }, "description": { "type": "string", "description": "Environment description", "example": "Production environment" }, "limit_mode": { "type": "string", "description": "Environment limit mode", "enum": [ "none", "restrict", "notify" ] }, "limit_value": { "type": "number", "description": "Environment limit value", "example": 100000 }, "is_restricted": { "type": "boolean", "description": "Whether the environment is restricted", "example": false }, "restricted_at": { "type": "string", "description": "Date when environment was restricted", "example": "2024-05-31T01:24:39.506Z" }, "created_at": { "type": "string", "description": "Date when environment was created", "example": "2024-05-31T01:24:39.506Z" }, "updated_at": { "type": "string", "description": "Date when environment was last updated", "example": "2024-05-31T01:24:39.506Z" } }, "required": [ "id", "name", "is_restricted", "created_at", "updated_at" ] }, "EnvironmentsPaginatedResponseDtoV1": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentResponseDtoV1" } }, "metadata": { "$ref": "#/components/schemas/PaginationMetadata" } }, "required": [ "data", "metadata" ] }, "EnvironmentsPaginatedResponseDtoV2": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentResponseDtoV1" } }, "metadata": { "$ref": "#/components/schemas/PaginationMetadataV2" } }, "required": [ "data", "metadata" ] }, "CreateEnvironmentDtoV1": { "type": "object", "properties": { "name": { "type": "string", "description": "Name for the new environment", "maxLength": 255, "minLength": 3 }, "description": { "type": "string", "description": "Description for the environment", "maxLength": 256 }, "limit_mode": { "type": "string", "description": "Limit mode for the environment", "enum": [ "none", "restrict", "notify" ] }, "limit_value": { "type": "number", "description": "Limit value for the environment (required when limitMode is not \"none\")", "minimum": 1 } }, "required": [ "name" ] }, "EnvironmentApiResponseDtoV1": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EnvironmentResponseDtoV1" } }, "required": [ "data" ] }, "UpdateEnvironmentDtoV1": { "type": "object", "properties": { "name": { "type": "string", "description": "Name for the environment", "maxLength": 255 }, "description": { "type": "string", "description": "Description for the environment", "maxLength": 256 }, "limit_mode": { "type": "string", "description": "Limit mode for the environment", "enum": [ "none", "restrict", "notify" ] }, "limit_value": { "type": "number", "description": "Limit value for the environment (required when limitMode is not set to \"none\")" } } }, "FilteringRulesResponseDtoV1": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "origin" ], "description": "Type of filtering rule.", "example": "origin" }, "environment": { "type": "string", "description": "ID of an environment the filtering rule allies to.", "example": "ae_rrETjdWcfqI6AFsk" }, "allow": { "description": "List of origin domains that are allowed to make API requests. Wildcard entry (`*`) implies all domains are allowed.", "example": [ "example.com", "my-website.com" ], "type": "array", "items": { "type": "string" } }, "deny": { "description": "List of origin domains that are denied from making API requests. Wildcard entry (`*`) implies all domains are denied.", "example": [ "*" ], "type": "array", "items": { "type": "string" } } }, "required": [ "type", "environment", "allow", "deny" ] }, "bcdb2376818c770704cb8": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FilteringRulesResponseDtoV1" } } }, "required": [ "data" ] }, "CreateFilteringRuleDtoV1": { "type": "object", "properties": { "environment": { "type": "string", "description": "Environment for which to set filtering rule." }, "allow": { "description": "List of origin domains that are allowed to make requests, making all other domains denied by default. When setting the allow list, you must explicitly set the deny list to wildcard value (`['*']`).", "type": "array", "items": { "type": "string" } }, "deny": { "description": "List of origin domains that are denied to make requests, making all other domains allowed by default. When setting the deny list, you must explicitly set the allow list to wildcard value (`['*']`).", "type": "array", "items": { "type": "string" } } }, "required": [ "environment", "allow", "deny" ] }, "cdb2376818c770704cb8f": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FilteringRulesResponseDtoV1" } } }, "required": [ "data" ] }, "UpdateFilteringRuleDtoV1": { "type": "object", "properties": { "environment": { "type": "string", "description": "ID of an environment for which we are mutating the filtering rules." }, "permission": { "type": "string", "enum": [ "allow", "deny" ], "description": "Permission list we want to mutate, either `allow` or `deny`." }, "op": { "type": "string", "enum": [ "add", "remove" ], "description": "Operation we are executing on specified permission list, either `add` or `remove`." }, "items": { "description": "List of items we are mutating with the given operation on the given permission list.", "type": "array", "items": { "type": "string" } } }, "required": [ "environment", "permission", "op", "items" ] }, "db2376818c770704cb8ff": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FilteringRulesResponseDtoV1" } } }, "required": [ "data" ] }, "FilteringRuleResponseDtoV2": { "type": "object", "properties": { "id": { "type": "string", "description": "Auto-generated ID for the filtering rule", "example": "tr_abc123xyz" }, "name": { "type": "string", "description": "Name of the filtering rule", "example": "Block suspicious IPs" }, "environment": { "type": "string", "description": "Environment ID the rule belongs to", "example": "ae_rrETjdWcfqI6AFsk" }, "expression": { "type": "string", "description": "Expression in expr-lang format that defines the rule condition", "example": "http.request.ip in cidr('192.168.1.1/32')" }, "action": { "type": "string", "enum": [ "allow", "deny" ], "description": "Action to take when the rule matches", "example": "deny" }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "description": "Status of the filtering rule", "example": "enabled" }, "deny_with": { "type": "string", "nullable": true, "description": "Error message to return when denying a request", "example": "Forbidden" }, "created_at": { "format": "date-time", "type": "string", "description": "Date when the rule was created", "example": "2024-05-31T01:24:39.506Z" }, "updated_at": { "format": "date-time", "type": "string", "nullable": true, "description": "Date when the rule was last updated", "example": "2024-06-01T10:15:30.123Z" } }, "required": [ "id", "name", "environment", "expression", "action", "status", "created_at" ] }, "b2376818c770704cb8ff0": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FilteringRuleResponseDtoV2" } } }, "required": [ "data" ] }, "2376818c770704cb8ff0d": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FilteringRuleResponseDtoV2" } }, "required": [ "data" ] }, "PlacementDto": { "type": "object", "properties": { "position": { "type": "number", "description": "Position index to insert the rule at", "minimum": 0 }, "after": { "type": "string", "description": "ID of the rule to insert after" }, "before": { "type": "string", "description": "ID of the rule to insert before" } } }, "BaseFilteringRuleDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the filtering rule", "example": "Block suspicious IPs" }, "environment": { "type": "string", "description": "Environment ID", "example": "ae_rrETjdWcfqI6AFsk" }, "expression": { "type": "string", "description": "Expression in expr-lang format that defines the rule condition", "example": "http.request.ip in cidr('192.168.1.1/32')" }, "action": { "type": "string", "enum": [ "allow", "deny" ], "description": "Action to take when the rule matches", "example": "deny" }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "description": "Status of the filtering rule", "default": "enabled" }, "deny_with": { "type": "string", "enum": [ "Forbidden" ], "description": "Error message to return when denying a request", "example": "Forbidden" }, "placement": { "description": "Placement options for the rule", "allOf": [ { "$ref": "#/components/schemas/PlacementDto" } ] } }, "required": [ "name", "environment", "expression", "action" ] }, "376818c770704cb8ff0d6": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FilteringRuleResponseDtoV2" } }, "required": [ "data" ] }, "BulkFilteringRuleItemDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the filtering rule", "example": "Block suspicious IPs" }, "expression": { "type": "string", "description": "Expression in expr-lang format that defines the rule condition", "example": "http.request.ip in cidr('192.168.1.1/32')" }, "action": { "type": "string", "enum": [ "allow", "deny" ], "description": "Action to take when the rule matches", "example": "deny" }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "description": "Status of the filtering rule", "default": "enabled" }, "deny_with": { "type": "string", "enum": [ "Forbidden" ], "description": "Error message to return when denying a request", "example": "Forbidden" }, "placement": { "description": "Placement options for the rule", "allOf": [ { "$ref": "#/components/schemas/PlacementDto" } ] } }, "required": [ "name", "expression", "action" ] }, "BulkFilteringRulesDtoV2": { "type": "object", "properties": { "rules": { "description": "Array of filtering rules to create or update", "type": "array", "items": { "$ref": "#/components/schemas/BulkFilteringRuleItemDto" } }, "mode": { "type": "string", "enum": [ "merge", "overwrite" ], "description": "Mode for bulk operation. \"merge\" (default) updates existing rules and creates new ones. \"overwrite\" deletes all existing rules for the environment and creates new ones.", "default": "merge" }, "environment": { "type": "string", "description": "Environment ID", "example": "ae_rrETjdWcfqI6AFsk" } }, "required": [ "rules", "environment" ] }, "76818c770704cb8ff0d6e": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FilteringRuleResponseDtoV2" } } }, "required": [ "data" ] }, "TestRuleDto": { "type": "object", "properties": { "expression": { "type": "string", "description": "Expression in expr-lang format that defines the rule condition", "example": "http.request.ip in cidr('192.168.1.1/32')" }, "action": { "type": "string", "enum": [ "allow", "deny" ], "description": "Action to take when the rule matches", "example": "deny" }, "deny_with": { "type": "string", "enum": [ "Forbidden" ], "description": "Error message to return when denying a request", "example": "Forbidden" } }, "required": [ "expression", "action" ] }, "TestPayloadDto": { "type": "object", "properties": { "headers": { "type": "object", "description": "Request headers as key-value pairs with array values", "example": { "user-agent": [ "Mozilla/5.0" ], "accept": [ "application/json" ] } }, "ip": { "type": "string", "description": "IP address of the request", "example": "192.168.1.1" }, "userAgent": { "type": "string", "description": "User agent string", "example": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36" }, "sdkPlatform": { "type": "string", "enum": [ "js", "android", "ios" ], "description": "SDK platform", "example": "js" }, "sdkVersion": { "type": "string", "description": "SDK version", "example": "3.8.0" }, "appPackageName": { "type": "string", "description": "Application package name", "example": "com.example.app" } } }, "TestFilteringRulesDtoV2": { "type": "object", "properties": { "rules": { "description": "Array of rules to test. If omitted, provide environment ID to test against existing rules.", "type": "array", "items": { "$ref": "#/components/schemas/TestRuleDto" } }, "environment": { "type": "string", "description": "Environment ID. Must be provided if rules are not", "example": "ae_rrETjdWcfqI6AFsk" }, "test_request_id": { "type": "string", "description": "Request ID to test against (up to 3 months old)", "example": "req_abc123xyz" }, "test_request_payload": { "description": "Request data to test against", "allOf": [ { "$ref": "#/components/schemas/TestPayloadDto" } ] } } }, "TestFilteringRulesResponseDtoV2": { "type": "object", "properties": { "result": { "type": "string", "enum": [ "allow", "deny" ], "description": "Result of the test", "example": "deny" }, "deny_with": { "type": "string", "nullable": true, "description": "Error message if request was denied", "example": "Forbidden" }, "triggered_rule": { "type": "string", "nullable": true, "description": "Expression of the triggered rule", "example": "http.request.ip in cidr('192.168.1.1/32')" } }, "required": [ "result", "deny_with", "triggered_rule" ] }, "6818c770704cb8ff0d6ec": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TestFilteringRulesResponseDtoV2" } }, "required": [ "data" ] }, "UpdateFilteringRuleDtoV2": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the filtering rule", "example": "Block suspicious IPs" }, "environment": { "type": "string", "description": "Environment ID", "example": "ae_rrETjdWcfqI6AFsk" }, "expression": { "type": "string", "description": "Expression in expr-lang format that defines the rule condition", "example": "http.request.ip in cidr('192.168.1.1/32')" }, "action": { "type": "string", "enum": [ "allow", "deny" ], "description": "Action to take when the rule matches", "example": "deny" }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "description": "Status of the filtering rule", "default": "enabled" }, "deny_with": { "type": "string", "enum": [ "Forbidden" ], "description": "Error message to return when denying a request", "example": "Forbidden" }, "placement": { "description": "Placement options for the rule", "allOf": [ { "$ref": "#/components/schemas/PlacementDto" } ] }, "id": { "type": "string", "description": "ID of the filtering rule", "example": "tr_rrETjdWcfqI6AFsk" } }, "required": [ "id" ] }, "818c770704cb8ff0d6ec8": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FilteringRuleResponseDtoV2" } }, "required": [ "data" ] }, "WebhookRulesResponseDtoV1": { "type": "object", "properties": { "id": { "type": "string", "description": "Auto-generated ID for a webhook rule", "example": "tok_No3jUysGLCDuqB3RnCVf1weo" }, "name": { "type": "string", "description": "Webhook rule name", "example": "My webhook rule" }, "description": { "type": "string", "description": "Webhook rule description", "example": "Description for my webhook rule" }, "rule": { "type": "string", "description": "Content of the rule", "example": "ip == '0.0.0.0'" }, "createdAt": { "format": "date-time", "type": "string", "description": "Date when webhook rule was created", "example": "2024-05-31T01:24:39.506Z" } }, "required": [ "id", "name", "rule", "createdAt" ] }, "18c770704cb8ff0d6ec88": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookRulesResponseDtoV1" } } }, "required": [ "data" ] }, "CreateWebhookRuleDtoV1": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "rule": { "type": "string" } }, "required": [ "name", "description", "rule" ] }, "8c770704cb8ff0d6ec88f": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookRulesResponseDtoV1" } }, "required": [ "data" ] }, "WebhookEntityV1": { "type": "object", "properties": { "id": { "type": "string", "description": "Webhook ID.", "example": "wh_HYv9YfsIIUjpvR" }, "description": { "type": "string", "description": "Description of the webhook.", "example": "My Webhook" }, "status": { "type": "string", "description": "Status of the webhook: 'enabled' or 'disabled'.", "enum": [ "enabled", "disabled" ] }, "verified": { "type": "boolean", "description": "Indicates if the webhook endpoint has been verified.", "example": false }, "environment": { "type": "object", "description": "Environment ID this webhook is associated with. Null if global." }, "url": { "type": "string", "description": "URL of the webhook endpoint. Must start with https://.", "example": "https://website.com/webhook" }, "legacy": { "type": "boolean", "description": "True if webhook is legacy. See docs for more details." }, "signing_key": { "type": "string", "description": "The signing key for verifying webhook payloads. Will only be returned on creation. See docs for more details." }, "basic_auth": { "type": "object", "description": "Basic authentication credentials. Only applies to legacy webhooks.", "nullable": true }, "created_at": { "format": "date-time", "type": "string", "description": "Timestamp of when the webhook was created." }, "last_enabled_at": { "type": "object", "description": "Timestamp of when the webhook was last enabled.", "nullable": true }, "last_disabled_at": { "type": "object", "description": "Timestamp of when the webhook was last disabled.", "nullable": true } }, "required": [ "id", "description", "status", "verified", "environment", "url", "legacy", "basic_auth", "created_at" ] }, "WebhooksPaginatedListResponseDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEntityV1" } }, "metadata": { "$ref": "#/components/schemas/PaginationMetadata" } }, "required": [ "data", "metadata" ] }, "WebhooksPaginatedListResponseDtoV2": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEntityV1" } }, "metadata": { "$ref": "#/components/schemas/PaginationMetadataV2" } }, "required": [ "data", "metadata" ] }, "CreateWebhookDtoV1": { "type": "object", "properties": { "url": { "type": "string", "description": "URL of the webhook endpoint. Must start with https://.", "example": "https://website.com/webhook" }, "description": { "type": "string", "description": "Description of the webhook.", "example": "My Webhook" }, "status": { "type": "string", "description": "Status of the webhook: 'enabled' or 'disabled'.", "enum": [ "enabled", "disabled" ] }, "environment": { "type": "object", "description": "Environment ID this webhook is associated with. Null if global." } }, "required": [ "url" ] }, "WebhookResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookEntityV1" }, "environment": { "type": "object", "description": "Environment ID this webhook is associated with. Null if global.", "nullable": true } }, "required": [ "data", "environment" ] }, "UpdateWebhookDtoV1": { "type": "object", "properties": { "url": { "type": "string", "description": "URL of the webhook endpoint. Must start with https://.", "example": "https://website.com/webhook" }, "description": { "type": "string", "description": "Description of the webhook.", "example": "My Webhook" }, "status": { "type": "string", "description": "Status of the webhook: 'enabled' or 'disabled'.", "enum": [ "enabled", "disabled" ] }, "environment": { "type": "object", "description": "Environment ID this webhook is associated with. Null if global." } } }, "EncryptionKeyResponseDtoV1": { "type": "object", "properties": { "id": { "type": "string", "description": "Auto-generated ID for an encryption key", "example": "tok_No3jUysGLCDuqB3RnCVf1weo" }, "name": { "type": "string", "description": "Encryption key name", "example": "My Encryption Key" }, "description": { "type": "string", "description": "Encryption key description", "example": "Description for my encryption key" }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "description": "API key status, indicates if an API keys is enabled or disabled.", "example": "enabled" }, "environment": { "type": "string", "description": "ID of an environment the encryption key belongs to.", "example": "ae_rrETjdWcfqI6AFsk", "nullable": true }, "previous_token": { "type": "string", "description": "Previous value of an encryption key. When a key is rotated, the previous value is stored so the rotation can be reverted. This field is immutable, and only visible upon creation.", "example": "eWDrrpGGLjDQW0LBA0Wj" }, "token": { "type": "string", "description": "Value of an encryption key. This field is immutable, and only visible upon creation.", "example": "eWDrrpGGLjDQW0LBA0Wj" }, "next_token": { "type": "string", "description": "Next value of an encryption key. Becomes the current value when a key is rotated.", "example": "eWDrrpGGLjDQW0LBA0Wj" }, "created_at": { "format": "date-time", "type": "string", "description": "Date when encryption key was created.", "example": "2024-05-31T01:24:39.506Z" }, "last_activated_at": { "format": "date-time", "type": "string", "description": "Date when encryption key status was last changed to active.", "example": "2024-05-31T01:24:39.506Z", "nullable": true }, "last_rotated_at": { "format": "date-time", "type": "string", "description": "Date when encryption key status was last rotated.", "example": "2024-05-31T01:24:39.506Z", "nullable": true }, "last_deactivated_at": { "format": "date-time", "type": "string", "description": "Date when encryption key was disabled.", "example": null } }, "required": [ "id", "name", "status", "environment", "created_at", "last_activated_at", "last_rotated_at" ] }, "EncryptionKeysPaginatedResponseDtoV1": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EncryptionKeyResponseDtoV1" } }, "metadata": { "$ref": "#/components/schemas/PaginationMetadataV2" } }, "required": [ "data", "metadata" ] }, "770704cb8ff0d6ec88f18": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EncryptionKeyResponseDtoV1" } }, "required": [ "data" ] }, "70704cb8ff0d6ec88f189": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EncryptionKeyResponseDtoV1" } }, "required": [ "data" ] }, "0704cb8ff0d6ec88f1897": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EncryptionKeyResponseDtoV1" } }, "required": [ "data" ] }, "UpdateEncryptionKeyDtoV1": { "type": "object", "properties": { "name": { "type": "string", "description": "Set encryption key name." }, "description": { "type": "string", "description": "Set encryption key description." }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "description": "Set encryption key status. Use to enable or disable an encryption key." } } }, "704cb8ff0d6ec88f1897f": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EncryptionKeyResponseDtoV1" } }, "required": [ "data" ] } } }, "security": [ { "Management-API-key": [] } ] }