automation-anywhere Credentials API

Create, retrieve, update, delete, and search credentials

Documentation GitHub OpenAPI

Business capability

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /credentials Create a credential in the Credential Vault · Create a credential #

Ask an LLM

“How do I add a new username and password credential to the Credential Vault?”

“Can I define the attribute fields of a credential when I first create it?”

Tell an agent

Create a credential named {name} in the Credential Vault.

Create credential {name} described as {description} with attributes {attributes}.

POST /credentials/list Search credentials I own or can access · Search credentials #

Ask an LLM

“Which credentials do I own or have access to through a Locker?”

“Can I search the Credential Vault by name and sort the results?”

Tell an agent

Search my credentials matching {filter}.

List every credential I can access, sorted by {sort}.

GET /credentials/{id} Get a credential and its attributes · Get a credential by ID #

Ask an LLM

“What attributes and current values does a specific credential have?”

“Can I fetch a credential's values in the format a bot consumes them?”

Tell an agent

Show credential {id} with its attributes.

Fetch credential {id} in bot-consumption format ({consumed}).

PUT /credentials/{id} Rename or redefine a credential · Update a credential #

Ask an LLM

“Can I rename a credential or change its description after creating it?”

“What happens to attributes I leave out when I edit a credential's definition?”

Tell an agent

Rename credential {id} to {name}.

Replace the attribute definitions on credential {id} with {attributes}.

DELETE /credentials/{id} Delete a credential from the Credential Vault · Delete a credential #

Ask an LLM

“Can I permanently delete a credential and all its stored values?”

“Why can't I delete a credential that is still in a Locker?”

Tell an agent destructive · confirm first

Delete credential {id} from the Credential Vault.

Permanently remove credential {id} and all its attribute values.

PUT /credentials/{id}/owner/{credentialOwnerId} Transfer a credential to a new owner · Update credential ownership #

Ask an LLM

“Can I hand ownership of a credential over to another user?”

“What control does a new credential owner get after a transfer?”

Tell an agent

Transfer ownership of credential {id} to user {credentialOwnerId}.

Make user {credentialOwnerId} the owner of credential {id}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/automation-anywhere:automation-anywhere-credentials-api"

All apis

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.

Get an API 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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Automation Anywhere Credential Vault Credentials API
  description: The Automation Anywhere Credential Vault API provides programmatic access to the Control Room's centralized secrets management system.
  version: '2019'
  contact:
    name: Automation Anywhere Support
    url: https://support.automationanywhere.com
  termsOfService: https://www.automationanywhere.com/terms-of-service
servers:
- url: https://{controlRoomUrl}/v2/credentialvault
  description: Automation Anywhere Control Room Credential Vault API v2
  variables:
    controlRoomUrl:
      default: your-control-room.automationanywhere.com
      description: Your Control Room hostname
security:
- bearerAuth: []
- xAuthorization: []
tags:
- name: Credentials
  description: Create, retrieve, update, delete, and search credentials
paths:
  /credentials:
    post:
      operationId: createCredential
      summary: Create a credential
      description: Creates a new credential in the Credential Vault. A credential consists of a name, optional description, and one or more typed attributes (such as username and password fields). Once created, credentials must be added to a Locker to be accessible by bots.
      tags:
      - Credentials
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialPost'
      responses:
        '200':
          description: Credential created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /credentials/list:
    post:
      operationId: listCredentials
      summary: Search credentials
      description: Searches for credentials where the authenticated user is the owner or has access through a Locker. Supports filtering, sorting, and pagination. Only credential metadata is returned; attribute values are not included in list responses.
      tags:
      - Credentials
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterRequest'
      responses:
        '200':
          description: Filtered list of credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialFilterResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /credentials/{id}:
    get:
      operationId: getCredential
      summary: Get a credential by ID
      description: Retrieves a specific credential by its numeric ID, including its attributes and current values if the caller has access. The consumed query parameter controls whether to return attribute values intended for bot consumption.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/CredentialIdParam'
      - $ref: '#/components/parameters/ConsumedParam'
      responses:
        '200':
          description: Credential details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Credential not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      operationId: updateCredential
      summary: Update a credential
      description: Updates an existing credential's name, description, or attributes. The caller must be the credential owner or have admin permissions. All attributes must be included in the request; omitted attributes will be removed.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/CredentialIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Credential'
      responses:
        '200':
          description: Credential updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Credential not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: deleteCredential
      summary: Delete a credential
      description: Permanently deletes a credential and all its associated attribute values from the Credential Vault. The credential must first be removed from any Lockers before it can be deleted.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/CredentialIdParam'
      responses:
        '200':
          description: Credential deleted successfully
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Credential not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /credentials/{id}/owner/{credentialOwnerId}:
    put:
      operationId: updateCredentialOwner
      summary: Update credential ownership
      description: Transfers ownership of a credential to another user. The new owner gains full administrative control over the credential including the ability to update, delete, and manage locker assignments.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/CredentialIdParam'
      - name: credentialOwnerId
        in: path
        required: true
        description: Numeric ID of the user who will become the new credential owner
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Credential ownership updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Credential or new owner not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    ConsumedParam:
      name: consumed
      in: query
      required: false
      description: Whether to return attribute values in bot-consumption format
      schema:
        type: boolean
    CredentialIdParam:
      name: id
      in: path
      required: true
      description: Unique numeric identifier of the credential
      schema:
        type: integer
        format: int64
  schemas:
    Credential:
      type: object
      description: A credential stored in the Credential Vault with named attributes
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier of the credential
        name:
          type: string
          description: Human-readable name of the credential
        description:
          type: string
          description: Optional description of the credential's purpose
        ownerId:
          type: integer
          format: int64
          description: User ID of the credential owner
        attributes:
          type: array
          description: List of attribute definitions associated with this credential
          items:
            $ref: '#/components/schemas/CredentialAttribute'
        createdBy:
          type: integer
          format: int64
          description: ID of the user who created this credential
        createdOn:
          type: string
          format: date-time
          description: ISO 8601 timestamp when the credential was created
        updatedBy:
          type: integer
          format: int64
          description: ID of the user who last modified this credential
        updatedOn:
          type: string
          format: date-time
          description: ISO 8601 timestamp of the last modification
    Error:
      type: object
      description: Standard error response
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Human-readable error description
    PageInfo:
      type: object
      description: Pagination metadata in list responses
      properties:
        offset:
          type: integer
          description: Starting index of the returned results
        total:
          type: integer
          description: Total number of records available
        totalFilter:
          type: integer
          description: Total records after filter criteria applied
    CredentialAttribute:
      type: object
      description: An attribute definition associated with a credential
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier of the attribute
        name:
          type: string
          description: Attribute name (e.g., username, password)
        description:
          type: string
          description: Description of what this attribute contains
        masked:
          type: boolean
          description: Whether this attribute's value should be masked in logs and UI
        userProvided:
          type: boolean
          description: Whether each user provides their own value for this attribute
    CredentialAttributePost:
      type: object
      description: Attribute definition for creating a new credential
      required:
      - name
      properties:
        name:
          type: string
          description: Attribute name
        description:
          type: string
          description: Description of the attribute
        masked:
          type: boolean
          description: Whether to mask this attribute's value
        userProvided:
          type: boolean
          description: Whether users provide their own values
    CredentialFilterResponse:
      type: object
      description: Paginated list of credentials matching search criteria
      properties:
        list:
          type: array
          description: Array of credential records
          items:
            $ref: '#/components/schemas/Credential'
        page:
          $ref: '#/components/schemas/PageInfo'
    FilterRequest:
      type: object
      description: Generic filter, sort, and pagination request for list operations
      properties:
        filter:
          type: object
          description: Filter expression for narrowing results
        sort:
          type: array
          description: Sort criteria for the result set
          items:
            type: object
            properties:
              field:
                type: string
                description: Field to sort by
              direction:
                type: string
                enum:
                - asc
                - desc
                description: Sort direction
        page:
          $ref: '#/components/schemas/PageRequest'
    PageRequest:
      type: object
      description: Pagination parameters
      properties:
        offset:
          type: integer
          description: Zero-based starting index
          minimum: 0
        length:
          type: integer
          description: Number of records per page
          minimum: 1
    CredentialPost:
      type: object
      description: Payload to create a new credential
      required:
      - name
      properties:
        name:
          type: string
          description: Human-readable name for the new credential
        description:
          type: string
          description: Optional description of the credential's purpose
        attributes:
          type: array
          description: Attribute definitions for this credential
          items:
            $ref: '#/components/schemas/CredentialAttributePost'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from the Authentication API
    xAuthorization:
      type: apiKey
      in: header
      name: X-Authorization
      description: JWT token obtained from the Authentication API
externalDocs:
  description: Automation Anywhere Credential Vault API Documentation
  url: https://docs.automationanywhere.com/bundle/enterprise-v2019/page/cv-api-supported.html

automation-anywhere Credentials API

Operations 6

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification