UiPath Assets API

openapi: 3.2.0
info:
  title: UiPath Automation Hub Alerts Assets API
  description: The UiPath Automation Hub API provides access to the automation pipeline and idea management platform, allowing developers to programmatically create, retrieve, and manage automation ideas, projects, and pipeline data. The API is accessible at the tenant-scoped endpoint https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/ and uses token-based authentication generated from the Automation Hub Admin Console. It is designed for organizations building Center of Excellence workflows, integrating Automation Hub data with external tools, or automating pipeline governance processes. A Postman collection and Swagger interface are available for exploring and testing endpoints.
  version: '1.0'
  contact:
    name: UiPath Support
    url: https://support.uipath.com
  termsOfService: https://www.uipath.com/legal/terms-of-use
servers:
- url: https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1
  description: UiPath Automation Cloud Automation Hub
  variables:
    orgName:
      default: your-org
      description: The name of your UiPath organization
    tenantName:
      default: your-tenant
      description: The name of your UiPath tenant
security:
- apiKeyAuth: []
tags:
- name: Assets
  description: Manage shared assets such as credentials, text values, integers, and boolean values
paths:
  /odata/Assets:
    get:
      operationId: listAssets
      summary: UiPath List Assets
      description: Retrieves a list of assets defined in the current folder. Assets store shared values such as credentials, text, integers, and booleans that can be consumed by automation processes. Supports OData filtering and pagination.
      tags:
      - Assets
      parameters:
      - $ref: '#/components/parameters/odataFilter'
        example: example-value
      - $ref: '#/components/parameters/odataTop'
        example: example-value
      - $ref: '#/components/parameters/odataSkip'
        example: example-value
      - $ref: '#/components/parameters/xUiPathOrganizationUnitId'
        example: example-value
      responses:
        '200':
          description: A list of assets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ODataAssetCollection'
              examples:
                listAssets200Example:
                  summary: Default listAssets 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - {}
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createAsset
      summary: UiPath Create an Asset
      description: 'Creates a new asset in the current folder. The asset type determines the kind of value stored: Text, Integer, Bool, or Credential. Credential assets store username and password pairs securely.'
      tags:
      - Assets
      parameters:
      - $ref: '#/components/parameters/xUiPathOrganizationUnitId'
        example: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Asset'
            examples:
              createAssetRequestExample:
                summary: Default createAsset request
                x-microcks-default: true
                value:
                  Id: 1
                  Name: example-value
                  ValueType: Text
                  StringValue: example-value
                  IntValue: 1
                  BoolValue: true
                  CredentialUsername: example-value
                  CredentialPassword: example-value
                  Description: example-value
                  OrganizationUnitId: 1
      responses:
        '201':
          description: Asset created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Asset'
              examples:
                createAsset201Example:
                  summary: Default createAsset 201 response
                  x-microcks-default: true
                  value:
                    Id: 1
                    Name: example-value
                    ValueType: Text
                    StringValue: example-value
                    IntValue: 1
                    BoolValue: true
                    CredentialUsername: example-value
                    CredentialPassword: example-value
                    Description: example-value
                    OrganizationUnitId: 1
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /odata/Assets({key}):
    get:
      operationId: getAsset
      summary: UiPath Get an Asset by ID
      description: Retrieves a single asset by its unique integer identifier. Returns the full asset definition including type, value, and folder scope.
      tags:
      - Assets
      parameters:
      - $ref: '#/components/parameters/entityKey'
        example: example-value
      - $ref: '#/components/parameters/xUiPathOrganizationUnitId'
        example: example-value
      responses:
        '200':
          description: The requested asset
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Asset'
              examples:
                getAsset200Example:
                  summary: Default getAsset 200 response
                  x-microcks-default: true
                  value:
                    Id: 1
                    Name: example-value
                    ValueType: Text
                    StringValue: example-value
                    IntValue: 1
                    BoolValue: true
                    CredentialUsername: example-value
                    CredentialPassword: example-value
                    Description: example-value
                    OrganizationUnitId: 1
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateAsset
      summary: UiPath Update an Asset
      description: Updates an existing asset by its unique integer identifier. The full asset object must be provided in the request body with the updated values.
      tags:
      - Assets
      parameters:
      - $ref: '#/components/parameters/entityKey'
        example: example-value
      - $ref: '#/components/parameters/xUiPathOrganizationUnitId'
        example: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Asset'
            examples:
              updateAssetRequestExample:
                summary: Default updateAsset request
                x-microcks-default: true
                value:
                  Id: 1
                  Name: example-value
                  ValueType: Text
                  StringValue: example-value
                  IntValue: 1
                  BoolValue: true
                  CredentialUsername: example-value
                  CredentialPassword: example-value
                  Description: example-value
                  OrganizationUnitId: 1
      responses:
        '200':
          description: Asset updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Asset'
              examples:
                updateAsset200Example:
                  summary: Default updateAsset 200 response
                  x-microcks-default: true
                  value:
                    Id: 1
                    Name: example-value
                    ValueType: Text
                    StringValue: example-value
                    IntValue: 1
                    BoolValue: true
                    CredentialUsername: example-value
                    CredentialPassword: example-value
                    Description: example-value
                    OrganizationUnitId: 1
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteAsset
      summary: UiPath Delete an Asset
      description: Permanently deletes an asset from the current folder by its unique integer identifier. This action cannot be undone. Processes that reference this asset will fail until the asset is recreated.
      tags:
      - Assets
      parameters:
      - $ref: '#/components/parameters/entityKey'
        example: example-value
      - $ref: '#/components/parameters/xUiPathOrganizationUnitId'
        example: example-value
      responses:
        '204':
          description: Asset deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    entityKey:
      name: key
      in: path
      required: true
      description: The unique integer identifier of the entity
      schema:
        type: integer
        format: int64
    xUiPathOrganizationUnitId:
      name: X-UIPATH-OrganizationUnitId
      in: header
      required: false
      description: The numeric ID of the folder context for the request. Required when accessing folder-scoped resources. Retrieve folder IDs using the /odata/Folders endpoint.
      schema:
        type: integer
        format: int64
    odataTop:
      name: $top
      in: query
      required: false
      description: Maximum number of records to return (default 100, max 1000)
      schema:
        type: integer
        minimum: 1
        maximum: 1000
    odataFilter:
      name: $filter
      in: query
      required: false
      description: OData filter expression to narrow results (e.g., State eq 'Running')
      schema:
        type: string
    odataSkip:
      name: $skip
      in: query
      required: false
      description: Number of records to skip for pagination
      schema:
        type: integer
        minimum: 0
  responses:
    BadRequest:
      description: The request was malformed or contained invalid parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: The request lacks valid authentication credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ODataAssetCollection:
      type: object
      description: OData collection response containing assets
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Asset'
          example: []
    ErrorResponse:
      type: object
      description: Standard error response body
      properties:
        message:
          type: string
          description: Human-readable error message
          example: example-value
        errorCode:
          type: integer
          description: Numeric error code
          example: 1
        traceId:
          type: string
          description: Trace identifier for support and debugging
          example: abc123
    Asset:
      type: object
      description: A shared asset storing a value accessible to automation processes
      properties:
        Id:
          type: integer
          format: int64
          description: Unique integer identifier of the asset
          example: 12345
        Name:
          type: string
          description: Display name of the asset
          example: Example Name
        ValueType:
          type: string
          enum:
          - Text
          - Integer
          - Bool
          - Credential
          - WindowsCredential
          - KeyValueList
          description: Data type of the asset value
          example: Text
        StringValue:
          type: string
          description: Value when ValueType is Text
          example: example-value
        IntValue:
          type: integer
          description: Value when ValueType is Integer
          example: 1
        BoolValue:
          type: boolean
          description: Value when ValueType is Bool
          example: true
        CredentialUsername:
          type: string
          description: Username portion when ValueType is Credential
          example: Example Name
        CredentialPassword:
          type: string
          description: Password portion when ValueType is Credential (write-only)
          example: example-value
        Description:
          type: string
          description: Optional description of the asset's purpose
          example: Example description for this resource.
        OrganizationUnitId:
          type: integer
          format: int64
          description: ID of the folder in which this asset resides
          example: 12345
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'API token generated from the Automation Hub Admin Console under Platform Setup > Open API. Include as a Bearer token in the Authorization header: "Bearer {token}".'
externalDocs:
  description: UiPath Automation Hub API Documentation
  url: https://docs.uipath.com/automation-hub/automation-cloud/latest/api-guide/introduction-to-automation-hub-api-1