Automation Anywhere

automation-anywhere Lockers API

Create, retrieve, update, and delete credential lockers

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 8

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 /lockers Create a locker in the Credential Vault · Create a locker #
Ask an LLM
“How do I create a Locker to group credentials for bots?”
“What is a Locker in the Credential Vault used for?”
Tell an agent
Create a locker named {name}.
Create locker {name} described as {description}.
POST /lockers/list Search lockers I have access to · Search lockers #
Ask an LLM
“Which Lockers do I have access to?”
“Can I search Lockers by name?”
Tell an agent
List all lockers I can access.
Search lockers matching {filter}.
GET /lockers/{id} Get a locker's details · Get a locker by ID #
Ask an LLM
“What are the name, description and configuration of a specific Locker?”
“Can I look up a Locker by its ID?”
Tell an agent
Show the details of locker {id}.
Get the configuration of locker {id}.
PUT /lockers/{id} Rename or redescribe a locker · Update a locker #
Ask an LLM
“Can I rename an existing Locker?”
“Who is allowed to change a Locker's name or description?”
Tell an agent
Rename locker {id} to {name}.
Update locker {id} with name {name} and description {description}.
DELETE /lockers/{id} Delete a locker · Delete a locker #
Ask an LLM
“Are the credentials deleted when I delete their Locker?”
“Can I permanently remove a Locker I no longer need?”
Tell an agent destructive · confirm first
Delete locker {id}.
Permanently remove locker {id} and its credential associations.
GET /lockers/{id}/credentials List the credentials inside a locker · Get locker credentials #
Ask an LLM
“Which credentials are stored in a particular Locker?”
“What credential attributes can bots consume through a Locker?”
Tell an agent
List the credentials in locker {id}.
Show which credentials and attributes locker {id} exposes to bots.
PUT /lockers/{id}/credentials/{credentialId} Change which credential attributes a locker exposes · Update a credential in a locker #
Ask an LLM
“Can I limit which attributes of a credential are exposed to consumer roles through a Locker?”
“How do I edit a credential's configuration inside a Locker?”
Tell an agent
Expose attributes {attributes} of credential {credentialId} through locker {id}.
Update how credential {credentialId} is configured inside locker {id}.
DELETE /lockers/{id}/credentials/{credentialId} Remove a credential from a locker · Remove a credential from a locker #
Ask an LLM
“Can I take a credential out of a Locker without deleting it from the vault?”
“What happens to consumer access when a credential is removed from a Locker?”
Tell an agent destructive · confirm first
Remove credential {credentialId} from locker {id}.
Take credential {credentialId} out of locker {id} but keep it in the Credential Vault.

Documentation

📖
Documentation
https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/control-room/control-room-api/cloud-control-room-apis.html
📖
Documentation
https://docs.automationanywhere.com/bundle/enterprise-v2019/page/deploy-api-supported-v4.html
📖
Documentation
https://docs.automationanywhere.com/bundle/enterprise-v2019/page/wlm-api-supported-v4.html
📖
Documentation
https://docs.automationanywhere.com/bundle/enterprise-v11.3/page/enterprise/topics/bot-insight/user/bot-insight-apis.html
📖
Documentation
https://docs.automationanywhere.com/bundle/enterprise-v2019/page/api-task-real-time-endpoint.html
📖
Documentation
https://docs.automationanywhere.com/bundle/enterprise-v2019/page/cv-api-supported.html
📖
Documentation
https://docs.automationanywhere.com/bundle/enterprise-v2019/page/repository-management-api.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/automation-anywhere/openapi/automation-anywhere-lockers-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/automation-anywhere/json-schema/automation-anywhere-deployment-schema.json
📊
JSONSchema
https://artifacts.apis.io/automation-anywhere/json-schema/automation-anywhere-work-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/automation-anywhere/json-schema/automation-anywhere-bot-schema.json

Other Resources

🔗
Overlay
https://artifacts.apis.io/automation-anywhere/overlays/automation-anywhere-lockers-api-overlay.yaml

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-lockers-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

automation-anywhere-lockers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Automation Anywhere Credential Vault Lockers 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: Lockers
  description: Create, retrieve, update, and delete credential lockers
paths:
  /lockers:
    post:
      operationId: createLocker
      summary: Create a locker
      description: Creates a new Locker in the Credential Vault. A Locker is a permission-controlled container that groups credentials and controls which roles (consumers) can use the credentials within it during bot execution. Lockers are the primary access control mechanism for the Credential Vault.
      tags:
      - Lockers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LockerPost'
      responses:
        '200':
          description: Locker created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Locker'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /lockers/list:
    post:
      operationId: listLockers
      summary: Search lockers
      description: Searches for Lockers that the authenticated user has access to. Returns paginated results with locker metadata. Supports filtering by name and other attributes.
      tags:
      - Lockers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterRequest'
      responses:
        '200':
          description: Filtered list of lockers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LockerListResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /lockers/{id}:
    get:
      operationId: getLocker
      summary: Get a locker by ID
      description: Retrieves a specific Locker by its numeric ID, including its name, description, and configuration. Does not include the list of contained credentials; use the locker credentials endpoint for that.
      tags:
      - Lockers
      parameters:
      - $ref: '#/components/parameters/LockerIdParam'
      responses:
        '200':
          description: Locker details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Locker'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Locker not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      operationId: updateLocker
      summary: Update a locker
      description: Updates an existing Locker's name and description. The caller must have Locker owner permissions to update its details.
      tags:
      - Lockers
      parameters:
      - $ref: '#/components/parameters/LockerIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LockerPost'
      responses:
        '200':
          description: Locker updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Locker'
        '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: Locker not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: deleteLocker
      summary: Delete a locker
      description: Permanently deletes a Locker. All credential associations within the Locker are removed. The credentials themselves are not deleted; they remain in the Credential Vault but lose Locker-based access.
      tags:
      - Lockers
      parameters:
      - $ref: '#/components/parameters/LockerIdParam'
      responses:
        '200':
          description: Locker deleted successfully
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Locker not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /lockers/{id}/credentials:
    get:
      operationId: listLockerCredentials
      summary: Get locker credentials
      description: Retrieves the list of credentials contained within a specific Locker. Returns credential metadata and the attributes available for bot consumption via the Locker's consumer roles.
      tags:
      - Lockers
      parameters:
      - $ref: '#/components/parameters/LockerIdParam'
      responses:
        '200':
          description: List of credentials in the locker
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LockerCredentialList'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Locker not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /lockers/{id}/credentials/{credentialId}:
    put:
      operationId: updateLockerCredential
      summary: Update a credential in a locker
      description: Updates the association or configuration of a credential within a Locker. Used to modify which credential attributes are exposed to consumer roles through this Locker.
      tags:
      - Lockers
      parameters:
      - $ref: '#/components/parameters/LockerIdParam'
      - $ref: '#/components/parameters/CredentialIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LockerCredentialUpdate'
      responses:
        '200':
          description: Locker credential updated successfully
        '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: Locker or credential not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: removeLockerCredential
      summary: Remove a credential from a locker
      description: Removes a credential from a Locker, revoking consumer role access to that credential through this Locker. The credential itself remains in the Credential Vault.
      tags:
      - Lockers
      parameters:
      - $ref: '#/components/parameters/LockerIdParam'
      - $ref: '#/components/parameters/CredentialIdParam'
      responses:
        '200':
          description: Credential removed from locker successfully
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Locker or credential not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Locker:
      type: object
      description: A permission-controlled container grouping credentials for bot access. Lockers define which roles (consumer roles) can access the contained credentials during automation execution.
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier of the locker
        name:
          type: string
          description: Human-readable name of the locker
        description:
          type: string
          description: Optional description of the locker's purpose
        ownerId:
          type: integer
          format: int64
          description: User ID of the locker owner
        createdBy:
          type: integer
          format: int64
          description: ID of the user who created this locker
        createdOn:
          type: string
          format: date-time
          description: ISO 8601 timestamp when the locker was created
        updatedBy:
          type: integer
          format: int64
          description: ID of the user who last modified this locker
        updatedOn:
          type: string
          format: date-time
          description: ISO 8601 timestamp of the last modification
    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
    LockerCredentialList:
      type: object
      description: List of credentials contained within a locker
      properties:
        list:
          type: array
          description: Array of credential records in the locker
          items:
            $ref: '#/components/schemas/Credential'
    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
    LockerPost:
      type: object
      description: Payload to create or update a locker
      required:
      - name
      properties:
        name:
          type: string
          description: Name for the locker
        description:
          type: string
          description: Description of the locker's purpose
    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
    LockerListResponse:
      type: object
      description: Paginated list of lockers
      properties:
        list:
          type: array
          description: Array of locker records
          items:
            $ref: '#/components/schemas/Locker'
        page:
          $ref: '#/components/schemas/PageInfo'
    LockerCredentialUpdate:
      type: object
      description: Payload to update a credential's configuration within a locker
      properties:
        attributes:
          type: array
          description: Credential attributes to expose through this locker
          items:
            type: integer
            format: int64
            description: Credential attribute ID
  parameters:
    CredentialIdParam:
      name: id
      in: path
      required: true
      description: Unique numeric identifier of the credential
      schema:
        type: integer
        format: int64
    LockerIdParam:
      name: id
      in: path
      required: true
      description: Unique numeric identifier of the locker
      schema:
        type: integer
        format: int64
  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