Mabl Credentials API
The Credentials API from Mabl — 2 operation(s) for credentials.
The Credentials API from Mabl — 2 operation(s) for credentials.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/mabl:mabl-credentials-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: mabl Credentials API
description: APIs for interacting with mabl services
version: 0.599.3.1792436330
x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Credentials
paths:
/credentials:
get:
tags:
- Credentials
summary: Query Credentials
description: Query for credentials. Decrypted credential provided only if `with_secrets` flag set `true` and is not available for cloud-only credentials.
operationId: queryCredentials
parameters:
- name: organization_id
in: query
description: Organization ID to filter on
required: true
style: form
explode: true
schema:
type: string
- name: with_secrets
in: query
description: DEPRECATED - unused - will always be false
required: false
style: form
explode: true
schema:
type: boolean
default: false
x-mabl-scope: private
- name: accessible_only
in: query
description: When true, filter credentials to only those accessible by the authenticated user based on RBAC resource group grants
required: false
style: form
explode: true
schema:
type: boolean
default: false
x-mabl-scope: private
- name: limit
in: query
description: Limit to use for pagination
required: false
style: form
explode: true
schema:
minimum: 1
type: integer
format: int32
- name: cursor
in: query
description: Cursor to use for pagination
required: false
style: form
explode: true
schema:
type: string
responses:
'200':
description: Results of the query
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialsWithResourceGroupsQueryResult'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
default:
$ref: '#/components/responses/ErrorResponse'
x-mabl-action: Read::Credential
x-mabl-scope: public
post:
tags:
- Credentials
summary: Create Credentials
description: Create new credentials
operationId: createCredentials
requestBody:
description: The credentials to create
content:
application/json:
schema:
$ref: '#/components/schemas/Credentials'
required: true
responses:
'201':
description: Credentials that were created
content:
application/json:
schema:
$ref: '#/components/schemas/Credentials'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
default:
$ref: '#/components/responses/ErrorResponse'
x-mabl-action: Create::Credential
x-mabl-scope: public
/credentials/{id}:
get:
tags:
- Credentials
summary: Get Credentials
description: 'Retrieve complete information about credentials. Includes plain text secrets. NOTE: TOTP secret keys are never returned to the client'
operationId: getCredentials
parameters:
- name: id
in: path
description: ID of credentials to retrieve
required: true
style: simple
explode: false
schema:
type: string
- name: with_secrets
in: query
description: Include secrets as decrypted plaintext
required: false
style: form
explode: true
schema:
type: boolean
default: true
- name: with_computed_totp_count
in: query
description: Include given number of TOTP pins, from current time (only applicable to MFA credentials for authorized callers)
required: false
style: form
explode: true
schema:
maximum: 15
type: integer
format: int32
default: 0
responses:
'200':
description: Credentials requested
content:
application/json:
schema:
$ref: '#/components/schemas/Credentials'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
'404':
description: Credentials not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseGeneric'
default:
$ref: '#/components/responses/ErrorResponse'
x-mabl-action: Read::Credential
x-mabl-scope: public
delete:
tags:
- Credentials
summary: Remove Credentials
description: Remove credentials
operationId: removeCredentials
parameters:
- name: id
in: path
description: ID of credentials to remove
required: true
style: simple
explode: false
schema:
type: string
responses:
'200':
description: Removed credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Credentials'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
'404':
description: Credentials not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseGeneric'
default:
$ref: '#/components/responses/ErrorResponse'
x-mabl-action: Delete::Credential
x-mabl-scope: public
patch:
tags:
- Credentials
summary: Update Credentials
description: 'Update existing credentials. NOTE: TOTP tokens will be unchanged if NULL passed. They will be cleared if '''' (blank string) is passed.'
operationId: updateCredentials
parameters:
- name: id
in: path
description: ID of credentials to update
required: true
style: simple
explode: false
schema:
type: string
- name: If-Match
in: header
description: If-Match header according to http/1.1 spec section 14.24
required: false
style: simple
explode: false
schema:
type: string
requestBody:
description: The update to apply
content:
application/json:
schema:
$ref: '#/components/schemas/Credentials'
required: true
responses:
'200':
description: Updated credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Credentials'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
'404':
description: Credentials not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseGeneric'
default:
$ref: '#/components/responses/ErrorResponse'
x-mabl-action: Edit::Credential
x-mabl-scope: public
components:
schemas:
ResourceGroupParentNamespace:
type: string
description: Namespace of the parent to which this ResourceGroup belongs
enum:
- workspaces
Tag:
required:
- name
type: object
properties:
name:
type: string
description: tag name
x-mabl-scope: public
values:
maxItems: 32
minItems: 0
type: array
items:
type: string
ErrorResponseGeneric:
type: object
properties:
id:
type: string
x-mabl-scope: public
code:
maximum: 599
minimum: 100
type: integer
format: int32
x-mabl-scope: public
message:
type: string
x-mabl-scope: public
error_code:
type: string
description: Machine-readable reason for the error, present only when the API names one. Values are guardrail_blocked (a guardrail policy refused an agent request), approval_required (a guardrail policy requires a person to approve the request first).
guardrail:
description: The guardrail policy that refused the request; present only when error_code is guardrail_blocked or approval_required.
allOf:
- $ref: '#/components/schemas/GuardrailRefusal'
GuardrailApprovalRef:
type: object
properties:
id:
type: string
description: The approval's id.
state:
description: Where the approval stands.
allOf:
- $ref: '#/components/schemas/GuardrailApprovalState'
kind:
description: Who decides the approval.
allOf:
- $ref: '#/components/schemas/GuardrailApprovalKind'
request_expires_time:
type: integer
description: When the approval expires if nobody decides it, in epoch milliseconds.
format: int64
url:
type: string
description: The mabl app page where a person reviews the approval.
description: 'An approval a guardrail policy asks for. While it is PENDING, stop: give the person the url, tell them the request is waiting for approval, and do not repeat the request or poll in a loop. Once a person tells you it is APPROVED, repeat the identical request with the header X-Mabl-Approval set to id. DENIED means a person said no, so do not work around it.'
CredentialsWithResourceGroupsQueryResult:
type: object
properties:
credentials:
type: array
description: All credentials that matched the query
readOnly: true
items:
$ref: '#/components/schemas/Credentials'
x-mabl-scope: public
cursor:
type: string
description: Cursor used for pagination
readOnly: true
x-mabl-scope: public
GuardrailRefusal:
type: object
properties:
id:
type: string
description: The id of the guardrail policy that decided the refusal.
reason:
type: string
description: Why the policy refuses the request, written for the person the agent acts for.
decision_id:
type: string
description: The id of this decision in the guardrail decision log.
action:
type: string
description: The action the request was evaluated as, written Verb::Resource (for example Delete::Test), as declared by the operation's x-mabl-action extension.
policy_source:
type: string
description: 'Who set the deciding policy: workspace for a rule the workspace''s owners wrote, account for a rule set for the workspace''s account, mabl_agent_type for the agent type''s ceiling, and mabl_default for mabl''s own defaults.'
approval:
description: The approval for this request; present when error_code is approval_required and the approval could be recorded. Without it the request cannot be approved.
allOf:
- $ref: '#/components/schemas/GuardrailApprovalRef'
description: The guardrail policy that refused an agent request.
ComputedTotpPin:
type: object
properties:
start_time:
type: integer
description: Starting Unix epoch millisecond key of validity window - lasts 60s
format: int64
x-mabl-scope: public
pin:
type: string
description: Computed pin for time frame
x-mabl-scope: public
DerivedResourceGroup:
type: object
properties:
resource_group_id:
type: string
description: ID of the resource group
short_name:
type: string
description: Name of the resource group
parent_id:
type: string
description: ID of the parent to which this ResourceGroup belongs
parent_namespace:
$ref: '#/components/schemas/ResourceGroupParentNamespace'
GuardrailApprovalKind:
type: string
description: Who decides a guardrail approval. SELF is decided by the person the agent acts for; WORKSPACE, for an agent acting for an API key, by a workspace owner or editor.
enum:
- SELF
- WORKSPACE
Credentials:
type: object
properties:
id:
type: string
description: ID of credentials
x-mabl-scope: public
created_time:
type: integer
description: Time credentials were created
format: int64
x-mabl-scope: public
created_by_id:
type: string
description: User ID who created these credentials
x-mabl-scope: public
last_updated_time:
type: integer
description: Time credentials entity was last updated
format: int64
x-mabl-scope: public
last_updated_by_id:
type: string
description: User ID who last updated these credentials
x-mabl-scope: public
organization_id:
type: string
description: Organization ID
x-mabl-scope: public
name:
type: string
description: Display name
x-mabl-scope: public
description:
type: string
description: Description
x-mabl-scope: public
tags:
type: array
description: Free text tags
items:
$ref: '#/components/schemas/Tag'
x-mabl-scope: public
totp_pins:
type: array
description: TOTP pins computed for time range (only for MFA type credentials, upon request by authorized caller)
items:
$ref: '#/components/schemas/ComputedTotpPin'
x-mabl-scope: public
cloud_only:
type: boolean
description: True if the credentials secrets are only accessible to cloud runs. Cannot be changed from true to false.
x-mabl-scope: public
type:
type: string
description: Type of credentials
enum:
- basic
- basic_with_totp
x-mabl-scope: public
properties:
type: object
additionalProperties:
type: string
description: Properties that are specific to the given credentials type.
x-mabl-scope: public
resource_groups:
type: array
description: Resource groups this resource belongs to
items:
$ref: '#/components/schemas/DerivedResourceGroup'
x-dao-derived: true
x-implements-interface:
- ActivityTrackingBaseEntity
- HasOrganizationId
- HasName
GuardrailApprovalState:
type: string
description: Where a guardrail approval stands. PENDING awaits a decision and expires undecided after 24 hours; APPROVED lets the agent repeat the request, as often as it does, for 20 minutes; DENIED refuses the same request for 20 minutes after the decision, after which asking again opens a new approval; CANCELLED means a person withdrew it while pending or revoked it while approved. EXPIRED and CANCELLED are final.
enum:
- PENDING
- APPROVED
- DENIED
- EXPIRED
- CANCELLED
responses:
ErrorResponse401:
description: User not authenticated
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseGeneric'
ErrorResponse400:
description: Invalid or missing parameter
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseGeneric'
ErrorResponse403:
description: User not authorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseGeneric'
ErrorResponse:
description: Unknown error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseGeneric'
securitySchemes:
basicAuth:
type: http
scheme: basic
bearerAuth:
type: apiKey
name: Authorization
in: header
x-provenance:
method: harvested
publisher: Mabl
source: https://api.mabl.com/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)