### GET /api/v2/capi-gateways Source: https://api.app.stape.io/api/doc List all CAPI gateways associated with the account. ```APIDOC ## GET /api/v2/capi-gateways ### Description Returns a list of all configured CAPI gateways. ### Method GET ### Endpoint /api/v2/capi-gateways ### Response #### Success Response (200) - **gateways** (array) - List of gateway objects #### Response Example { "gateways": [] } ``` -------------------------------- ### GET /api/v2/workspaces Source: https://api.app.stape.io/api/doc Retrieve a list of all workspaces associated with the current user. ```APIDOC ## GET /api/v2/workspaces ### Description Retrieve a list of all workspaces associated with the current user. ### Method GET ### Endpoint /api/v2/workspaces ### Response #### Success Response (200) - **workspaces** (array) - List of workspace objects #### Response Example { "workspaces": [ { "id": "ws_123", "name": "My Workspace" } ] } ``` -------------------------------- ### GET /api/v2/containers/{identifier}/analytics/clients Source: https://api.app.stape.io/api/doc Get subscription usage analytics for clients within a specific container. ```APIDOC ## GET /api/v2/containers/{identifier}/analytics/clients ### Description Retrieves client-side analytics data for a specific container. ### Method GET ### Endpoint /api/v2/containers/{identifier}/analytics/clients ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique container ID ### Response #### Success Response (200) - **data** (object) - Analytics data payload #### Response Example { "data": {} } ``` -------------------------------- ### GET /api/v2/containers/{id} Source: https://api.app.stape.io/api/doc Retrieve detailed information about a specific container. ```APIDOC ## GET /api/v2/containers/{id} ### Description Fetches the configuration and status details for a specific container ID. ### Method GET ### Endpoint /api/v2/containers/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique ID of the container ### Response #### Success Response (200) - **id** (string) - Container ID - **name** (string) - Container name - **status** (string) - Current operational status #### Response Example { "id": "uuid-1234-5678", "name": "my-gtm-container", "status": "active" } ``` -------------------------------- ### GET /api/v2/billing Source: https://api.app.stape.io/api/doc Retrieve current billing information for the authenticated account. ```APIDOC ## GET /api/v2/billing ### Description Retrieves the billing details for the current user account. ### Method GET ### Endpoint /api/v2/billing ### Response #### Success Response (200) - **billing_info** (object) - Billing details object #### Response Example { "status": "active", "plan": "pro" } ``` -------------------------------- ### GET /api/v2/signals-gateways/{identifier} Source: https://api.app.stape.io/api/doc Retrieve details for a specific Signals Gateway instance. ```APIDOC ## GET /api/v2/signals-gateways/{identifier} ### Description Fetch detailed information about a specific Signals Gateway using its unique identifier. ### Method GET ### Endpoint /api/v2/signals-gateways/{identifier} ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique ID of the signals gateway ### Response #### Success Response (200) - **gateway** (object) - Gateway details #### Response Example { "id": "sg_abc", "status": "active" } ``` -------------------------------- ### GET /api/v2/company/users Source: https://api.app.stape.io/api/doc Retrieve a list of users associated with the company account. ```APIDOC ## GET /api/v2/company/users ### Description Fetches all users linked to the current company. ### Method GET ### Endpoint /api/v2/company/users ### Response #### Success Response (200) - **users** (array) - List of user objects #### Response Example { "users": [{"id": "123", "email": "user@example.com"}] } ``` -------------------------------- ### GET /api/v2/containers/{identifier}/statistics Source: https://api.app.stape.io/api/doc Retrieves usage statistics for a specific container. ```APIDOC ## GET /api/v2/containers/{identifier}/statistics ### Description Retrieves the usage statistics for the specified container. ### Method GET ### Endpoint /api/v2/containers/{identifier}/statistics ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique ID of the container. ### Response #### Success Response (200) - **data** (object) - Container usage statistics object. #### Response Example { "requests": 15000, "bandwidth": "500MB" } ``` -------------------------------- ### GET /api/v2/invoices/{identifier} Source: https://api.app.stape.io/api/doc Retrieves detailed information for a specific invoice. ```APIDOC ## GET /api/v2/invoices/{identifier} ### Description Fetches detailed information about a specific invoice by its identifier. ### Method GET ### Endpoint /api/v2/invoices/{identifier} ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique ID of the invoice. ### Response #### Success Response (200) - **id** (string) - Invoice ID - **amount** (number) - Total amount - **status** (string) - Payment status #### Response Example { "id": "inv_123", "amount": 29.00, "status": "paid" } ``` -------------------------------- ### POST /api/v2/containers Source: https://api.app.stape.io/api/doc Create a new container instance for your workspace. ```APIDOC ## POST /api/v2/containers ### Description Creates a new container resource within the user's workspace using the ContainerCreateForm schema. ### Method POST ### Endpoint /api/v2/containers ### Parameters #### Request Body - **name** (string) - Required - The name of the container - **domain** (string) - Required - The custom domain for the container ### Request Example { "name": "my-gtm-container", "domain": "metrics.example.com" } ### Response #### Success Response (201) - **id** (string) - The unique identifier of the created container #### Response Example { "id": "uuid-1234-5678" } ``` -------------------------------- ### Container Monitoring API Source: https://api.app.stape.io/api/doc Endpoints for managing monitoring settings and rules for containers. ```APIDOC ## GET /api/v2/containers/{identifier}/monitoring ### Description Get a list of monitoring configurations for a container. ### Method GET ### Endpoint /api/v2/containers/{identifier}/monitoring ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. ### Request Example None ### Response #### Success Response (200) - monitoring_configs (array) - A list of monitoring configuration objects. #### Response Example ```json { "monitoring_configs": [ { "rule_id": "rule-1", "status": "active" } ] } ``` ``` ```APIDOC ## POST /api/v2/containers/{identifier}/monitoring ### Description Create a new monitoring rule for a container. ### Method POST ### Endpoint /api/v2/containers/{identifier}/monitoring ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **rule_details** (object) - Required - Details of the monitoring rule to create. ### Request Example ```json { "rule_details": { "name": "High CPU Usage Alert", "threshold": "80%" } } ``` ### Response #### Success Response (201) - rule (object) - The newly created monitoring rule. #### Response Example ```json { "rule_id": "new-rule-id", "name": "High CPU Usage Alert", "status": "active" } ``` ``` ```APIDOC ## GET /api/v2/containers/{identifier}/monitoring/{rule} ### Description Get details of a specific monitoring rule. ### Method GET ### Endpoint /api/v2/containers/{identifier}/monitoring/{rule} ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. - **rule** (string) - Required - The identifier of the monitoring rule. ### Request Example None ### Response #### Success Response (200) - rule_details (object) - The details of the monitoring rule. #### Response Example ```json { "rule_id": "rule-1", "name": "High CPU Usage Alert", "threshold": "80%", "status": "active" } ``` ``` ```APIDOC ## PUT /api/v2/containers/{identifier}/monitoring/{rule} ### Description Update an existing monitoring rule. ### Method PUT ### Endpoint /api/v2/containers/{identifier}/monitoring/{rule} ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. - **rule** (string) - Required - The identifier of the monitoring rule. #### Request Body - **rule_updates** (object) - Optional - Updates to apply to the monitoring rule. ### Request Example ```json { "rule_updates": { "threshold": "90%" } } ``` ### Response #### Success Response (200) - rule (object) - The updated monitoring rule. #### Response Example ```json { "rule_id": "rule-1", "name": "High CPU Usage Alert", "threshold": "90%", "status": "active" } ``` ``` ```APIDOC ## DELETE /api/v2/containers/{identifier}/monitoring/{rule} ### Description Delete a specific monitoring rule. ### Method DELETE ### Endpoint /api/v2/containers/{identifier}/monitoring/{rule} ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. - **rule** (string) - Required - The identifier of the monitoring rule. ### Request Example None ### Response #### Success Response (204) No content. #### Response Example None ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/monitoring/{rule} ### Description Switch the status of a monitoring rule (e.g., enable/disable). ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/monitoring/{rule} ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. - **rule** (string) - Required - The identifier of the monitoring rule. #### Request Body - **status** (string) - Required - The new status for the rule (e.g., "active", "inactive"). ### Request Example ```json { "status": "inactive" } ``` ### Response #### Success Response (200) - rule (object) - The updated monitoring rule. #### Response Example ```json { "rule_id": "rule-1", "name": "High CPU Usage Alert", "status": "inactive" } ``` ``` -------------------------------- ### POST /api/v2/share-users Source: https://api.app.stape.io/api/doc Create a new shared access entry for a user. ```APIDOC ## POST /api/v2/share-users ### Description Create a new share access record to grant permissions to another user. ### Method POST ### Endpoint /api/v2/share-users ### Request Body - **email** (string) - Required - User email to share with - **role** (string) - Required - Access level ### Response #### Success Response (200) - **id** (string) - Created share ID #### Response Example { "id": "share_999", "status": "created" } ``` -------------------------------- ### Container Power-Ups API Source: https://api.app.stape.io/api/doc Endpoints for managing various power-ups and configurations for containers. ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/custom-loader ### Description Switch and configure the custom loader power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/custom-loader ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable the custom loader. - **config** (object) - Optional - Configuration details for the custom loader. ### Request Example ```json { "enabled": true, "config": { "script_url": "http://example.com/loader.js" } } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "Custom loader power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/ad-blocker ### Description Switch the ad blocker power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/ad-blocker ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable the ad blocker. ### Request Example ```json { "enabled": true } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "Ad blocker power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/block-request-by-ip ### Description Switch the Block request by IP power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/block-request-by-ip ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable the power-up. - **ips_to_block** (array) - Optional - A list of IP addresses to block. ### Request Example ```json { "enabled": true, "ips_to_block": ["192.168.1.100"] } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "Block request by IP power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/cookie-keeper ### Description Switch and configure the cookie keeper power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/cookie-keeper ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable the cookie keeper. - **config** (object) - Optional - Configuration details for the cookie keeper. ### Request Example ```json { "enabled": true, "config": { "domain_whitelist": [".example.com"] } } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "Cookie keeper power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/anonymizer ### Description Switch and configure the anonymizer power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/anonymizer ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable the anonymizer. - **config** (object) - Optional - Configuration details for the anonymizer. ### Request Example ```json { "enabled": true, "config": { "ip_anonymization": true } } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "Anonymizer power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/preview-header-config ### Description Switch and configure the HTTP header configuration power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/preview-header-config ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable the header configuration. - **config** (object) - Optional - Configuration details for HTTP headers. ### Request Example ```json { "enabled": true, "config": { "headers": { "X-Custom-Header": "Value" } } } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "HTTP header config power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/service-account ### Description Switch and configure the Google service account power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/service-account ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable the service account. - **config** (object) - Optional - Configuration details for the service account. ### Request Example ```json { "enabled": true, "config": { "service_account_email": "sa@project.iam.gserviceaccount.com" } } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "Google service account power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/geo-headers ### Description Switch the geo headers power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/geo-headers ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable geo headers. ### Request Example ```json { "enabled": true } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "Geo headers power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/user-agent-headers ### Description Switch the user agent headers power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/user-agent-headers ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable user agent headers. ### Request Example ```json { "enabled": true } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "User agent headers power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/user-id ### Description Switch the user ID power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/user-id ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable the user ID feature. ### Request Example ```json { "enabled": true } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "User ID power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/xml-to-json ### Description Switch the XML to JSON power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/xml-to-json ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable the XML to JSON conversion. ### Request Example ```json { "enabled": true } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "XML to JSON power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/proxy-files ### Description Switch the proxy files power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/proxy-files ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable proxy files. ### Request Example ```json { "enabled": true } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "Proxy files power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/schedule ### Description Switch the schedule power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/schedule ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable the schedule. ### Request Example ```json { "enabled": true } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "Schedule power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/request-delay ### Description Switch the request delay power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/request-delay ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable the request delay. - **delay_ms** (integer) - Optional - The delay in milliseconds. ### Request Example ```json { "enabled": true, "delay_ms": 5000 } ``` ### Response #### Success Response (200) - message (string) - Confirmation message. #### Response Example ```json { "message": "Request delay power-up updated." } ``` ``` ```APIDOC ## PATCH /api/v2/containers/{identifier}/power-ups/bot-detection ### Description Switch the bot detection power-up for a container. ### Method PATCH ### Endpoint /api/v2/containers/{identifier}/power-ups/bot-detection ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the container. #### Request Body - **enabled** (boolean) - Required - Whether to enable or disable bot detection. ### Request Example ```json { "enabled": true } ``` ```