canonical: https://jentic.com/apis/assertible.com/assertible # Assertible Deployments API Jentic publishes the only available OpenAPI specification for Assertible Deployments API, keeping it validated and agent-ready. Assertible is an automated API testing service that runs continuous tests against web services. The Deployments API exposes a single POST endpoint that creates or updates a deployment record, which in turn triggers the configured test suite to run against that environment. Authentication is via HTTP basic auth using the Assertible API token. This API is purpose-built for CI/CD integration where every deploy should immediately be validated. ## For AI agents Trigger Assertible test runs by creating or updating a deployment record after a CI/CD pipeline finishes deploying. ## Scope Does not handle test authoring, browser tests, or full CI orchestration - use only for triggering Assertible test runs by creating or updating a deployment record. ## Capabilities - Trigger an Assertible test run by creating a deployment record - Update an existing deployment to associate it with a new commit or environment - Connect a CI/CD pipeline to automated post-deploy verification - Tag a test run with environment metadata such as 'staging' or 'production' - Drive deployment-gated test runs from a chat or agent context ## Use cases ### Post-Deploy Verification from CI/CD Wire POST /deployments into the final step of a CI/CD pipeline so every deploy automatically triggers the Assertible test suite for that environment. The endpoint accepts the service identifier and environment context, and Assertible runs the configured smoke and regression tests against the live URL. Removes the manual 'remember to kick off tests' step after a release. Example prompt: Call POST /deployments after a successful production release with environment='production' and commit SHA, then surface the test-run URL ### Multi-Environment Test Gating Use the same /deployments endpoint to record deploys to staging, QA, and production separately, so each environment has its own test history. Agents can read CI logs and call POST /deployments for the right environment, giving the QA team a clear timeline of when each environment was last validated. Example prompt: Call POST /deployments for the staging environment after the staging pipeline finishes, then again for production after the prod release ### AI Agent for Release Validation An agent integrated through Jentic can listen for deploy events on a CI platform, call POST /deployments to trigger Assertible tests, and report results back to the release channel - without holding the Assertible API token. Jentic stores the basic-auth credential in its vault and the agent calls the deployment endpoint by intent. Example prompt: Through Jentic, listen for GitHub deployment events, call POST /deployments on Assertible for each, and post the test result link back to the PR ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/deployments` | Create or update a deployment to trigger a test run | ## Key resources - **Deployments** — Create or update a deployment record to trigger Assertible test runs ## Why Jentic - **Setup:** Wiring Assertible by hand means encoding its API token as basic auth to trigger a test run through a single deployment endpoint. Through Jentic you install once, import the Assertible Deployments API from the API Directory, store the token once, and your agent calls it while Jentic builds the Authorization header. - **Permission scoping:** Assertible exposes a single deployment operation that carries its target in the request body rather than a URL path, so limit the agent to the operation it needs, which is creating or updating a deployment record. You choose the operations it may call, and no other operation is exposed. - **Credential handling:** Your Assertible API token is stored once, encrypted, by your own Jentic One instance as a basic-auth credential and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'trigger a post-deploy test run', and Jentic returns the POST /deployments operation with its input schema so the agent does not need to know the Assertible URL or basic-auth convention in advance. ## Related APIs - **BrowserStack** — BrowserStack runs cross-browser and device tests; Assertible focuses on API contract and uptime tests. - **Runscope** — Runscope (now part of BlazeMeter) covers API monitoring and testing similar to Assertible. - **GitHub API** — GitHub deployment events naturally trigger Assertible deployments via the GitHub Actions or webhook integration. - **CircleCI** — CircleCI pipelines can call POST /deployments as the final job of a release workflow. ## FAQ ### Why is there no official OpenAPI spec for Assertible Deployments API? Assertible documents this endpoint in their guide rather than as a published OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Assertible Deployments API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Assertible Deployments API use? The API uses HTTP basic authentication. The Assertible API token is supplied as the username with an empty password. Jentic stores the credential in its vault and constructs the basic-auth Authorization header at execution time. ### What does POST /deployments do? POST /deployments creates or updates a deployment record for a specific Assertible service and environment. Creating the record triggers the test suite configured for that service against the live URL. The response includes the deployment ID and a link to the test-run results. ### Can I trigger Assertible tests from any CI provider? Yes. POST /deployments is provider-agnostic - call it from GitHub Actions, GitLab CI, CircleCI, Jenkins, or any other system after the deploy step succeeds. Pass the environment and commit metadata in the request body to keep the test history traceable. ### What are the rate limits for the Assertible Deployments API? The OpenAPI specification does not publish explicit rate limits. The endpoint is intended to be called once per deploy, so volume is naturally low. Implement exponential backoff on HTTP 429 responses if a misconfigured pipeline triggers it more often than expected. ### How do I trigger a deployment test run through Jentic? Search Jentic for 'trigger an Assertible test run after a deploy' - POST /deployments will be returned. Load the operation schema, supply the service ID, environment, and commit details, and execute. Jentic handles the basic-auth credential and returns the deployment ID for downstream tracking. ### Can I limit what my agent is allowed to do with the Assertible Deployments API? Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use. The Assertible Deployments API exposes a single operation, POST /deployments, which creates or updates a deployment record, so you scope the agent to just that one operation and no other is available to it. Since the target service and environment travel in the request body rather than a URL path, you control what the agent may send, and the basic-auth token stays with your instance and is added at execution time.