OutSystems Deployed Assets API

openapi: 3.2.0
info:
  title: Outsystems Deployed Assets API
  version: '1.0'
  description: 'Operations tagged deployed-assets across 2 of this provider''s published API definitions: outsystems-portfolio-api-v1-openapi.json, outsystems-portfolio-api-v2-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ODC_PORTAL_DOMAIN/api/portfolios/v1
  description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/portfolios/v1
  description: Replace {odc-portal-domain} with the domain of your organization.
  variables:
    odc-portal-domain:
      default: ODC_PORTAL_DOMAIN
      description: The domain of your organization
- url: https://ODC_PORTAL_DOMAIN/api/portfolios/v2
  description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/portfolios/v2
  description: Replace {odc-portal-domain} with the domain of your organization.
  variables:
    odc-portal-domain:
      default: ODC_PORTAL_DOMAIN
      description: The domain of your organization
security:
- bearerAuth: []
tags:
- name: deployed-assets
paths:
  /deployed-assets:
    servers:
    - url: https://ODC_PORTAL_DOMAIN/api/portfolios/v1
      description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
    - url: https://{odc-portal-domain}/api/portfolios/v1
      description: Replace {odc-portal-domain} with the domain of your organization.
      variables:
        odc-portal-domain:
          default: ODC_PORTAL_DOMAIN
          description: The domain of your organization
    get:
      tags:
      - deployed-assets
      summary: Retrieves a list of deployed assets.
      description: 'Retrieves a list of deployed assets containing updated deployment status per environment (stage).

        Deprecated since 2026-07-08. Use GET /portfolios/v2/deployed-assets instead.

        This endpoint will be removed on or after 2027-01-08.


        The result only shows assets in environments (stages) for which the API Client has **Stage > View stage** permission.'
      operationId: DeployedAssets_ListAssets
      parameters:
      - name: environmentKey
        in: query
        description: Environment key on which to filter, comma separated.
        schema:
          type: string
      - name: key
        in: query
        description: Asset keys on which to filter, comma separated.
        schema:
          type: string
      - name: type
        in: query
        description: 'Asset types on which to filter, comma separated. Available values: WebApplication, MobileApplication, Workflow, Agent.'
        schema:
          type: array
          items:
            type: string
      - name: nameContains
        in: query
        description: Filter by matching on the name, case-insensitive.
        schema:
          type: string
      - name: permissionFilter
        in: query
        description: 'Filter by permission type. Format: ''PermissionType'' or ''PermissionType.EnvironmentKey'' for environment-specific permissions. Available values: AppViewSourceCode | AppDebug | AppChange | AppDelete | AppDeploy | AppRelease | AppMonitor | AppMonitorUserInfo | AppSecurityView | CodeQualityManage | CodeQualityView | AppUserView | AppAccessManage | AppGroupManage | CfgView | ConnConfig | AppCfgChange. Example: ''AppDeploy'' or ''AppDeploy.123e4567-e89b-12d3-a456-426614174000'''
        schema:
          type: string
      - name: limit
        in: query
        description: Max number of elements that should be returned in a single page.
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: Offset of the last page, to get the following page with the same filters applied.
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        description: 'Sort order of the elements.

          -element1 for descending, element2 for ascending.

          For nested sorting, the format is element1[key].element2 .

          Multiple orders joined by comma.

          Example: -element1,element2 to sort by element1 descending then by element2 ascending.

          Supported values for first order sorting: deployments (nested).

          For nested sorting: deploymentDateTime.

          Example: deployments[environmentkey].deploymentDatetime .

          Attention: the sorting only applies to the assets, not to the deployments.

          The deployments will always be sorted by the DeploymentDatetime, descending.'
        schema:
          type: string
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeployedAssetPagedListResponse'
      deprecated: true
      x-os-permissions: The result only shows assets in environments (stages) for which the API Client has **Stage > View stage** permission.
components:
  schemas:
    DeployedAssetPagedListResponse:
      type: object
      properties:
        page:
          allOf:
          - $ref: '#/components/schemas/PageInfoWithTotals'
          description: Page information.
          readOnly: true
        results:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DeployedAsset'
          description: List of results.
          readOnly: true
      additionalProperties: false
      description: Represents a response containing a paged set of results.
    DeployedAsset:
      required:
      - type
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
          description: The type of asset (WebApplication, MobileApplication, Workflow).
        key:
          type: string
          description: The asset key.
          format: uuid
        isBuiltIn:
          type: boolean
          description: Whether the asset is built-in.
        deployments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Deployment'
          description: Where the asset is deployed and its details.
      additionalProperties: false
      description: Deployed asset
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
          description: A URI reference that identifies the problem type.
        title:
          type:
          - string
          - 'null'
          description: A short, human-readable summary of the problem.
        status:
          type:
          - integer
          - 'null'
          description: The HTTP status code applicable to the problem.
          format: int32
        detail:
          type:
          - string
          - 'null'
          description: A human-readable explanation of the error.
        instance:
          type:
          - string
          - 'null'
          description: A URI that identifies the specific occurrence of the problem.
        traceId:
          type: string
          description: This field helps OutSystems support to track and investigate specific error occurrences. Providing this identifier when reporting an issue allows for more precise and faster  troubleshooting.
        errorCode:
          type: string
          description: This error code serves the purpose to communicate with OutSystems Support and help diagonose errors.
      description: A standardized error response as per RFC 7807 (Problem Details for HTTP APIs).
    PageInfoWithTotals:
      type: object
      properties:
        count:
          type: integer
          description: Number of results in the current page.
          format: int32
        limit:
          type: integer
          description: Limit of results per page.
          format: int32
        offset:
          type: integer
          description: Offset of the current page of results.
          format: int32
        nextPageOffset:
          type:
          - integer
          - 'null'
          description: Offset of the next page of results. Null when there is no next page.
          format: int32
        totalResults:
          type: integer
          description: Total of results.
          format: int32
        totalPages:
          type: integer
          description: Total of result pages.
          format: int32
          readOnly: true
      additionalProperties: false
      description: Contains response page information including totals.
    Deployment:
      required:
      - buildKey
      - deploymentDateTime
      - deploymentKey
      - deploymentUserId
      - description
      - environmentKey
      - iconUrl
      - name
      - revision
      - tag
      - taggingDateTime
      - taggingUserKey
      - url
      type: object
      properties:
        environmentKey:
          type: string
          description: The environment key in which the asset is deployed.
          format: uuid
        name:
          type:
          - string
          - 'null'
          description: The asset name.
        revision:
          type: integer
          description: The asset revision.
          format: int32
        buildKey:
          type: string
          description: The asset build key.
          format: uuid
        deploymentKey:
          type: string
          description: The deployment key.
          format: uuid
        deploymentDateTime:
          type: string
          description: The date at which the deployment occurred.
          format: date-time
        description:
          type:
          - string
          - 'null'
          description: The description of the asset.
        iconUrl:
          type:
          - string
          - 'null'
          description: The icon of the asset.
        deploymentUserId:
          type:
          - string
          - 'null'
          description: The id of the user that did the deployment.
        url:
          type:
          - string
          - 'null'
          description: The url for the deployment.
        tag:
          type:
          - string
          - 'null'
          description: The tag for this revision of the asset.
        taggingUserKey:
          type:
          - string
          - 'null'
          description: The id of the user that tagged the asset.
        taggingDateTime:
          type:
          - string
          - 'null'
          description: The date at which the asset was tagged.
          format: date-time
      additionalProperties: false
      description: Deployment instance
  securitySchemes:
    bearerAuth:
      type: http
      description: Enter your bearer token in the format 'Bearer {token}'
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- outsystems-portfolio-api-v1-openapi.json
- outsystems-portfolio-api-v2-openapi.json