OutSystems Environments API
The Environments API from OutSystems — 12 operation(s) for environments.
The Environments API from OutSystems — 12 operation(s) for environments.
openapi: 3.2.0
info:
title: Outsystems Environments API
version: '1.0'
description: 'Operations tagged Environments across 4 of this provider''s published API definitions: outsystems-asset-configurations-api-v1-openapi.json, outsystems-portfolio-api-v1-openapi.json, outsystems-portfolio-api-v2-openapi.json, outsystems-subscription-api-v1-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ODC_PORTAL_DOMAIN/api/asset-configurations/v1
description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/asset-configurations/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/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
- url: https://ODC_PORTAL_DOMAIN/api/subscription/v1
description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/subscription/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
security:
- bearerAuth: []
tags:
- name: Environments
paths:
/environments/{environmentKey}/agents/{agentKey}/revisions/deployed/configurations:
servers:
- url: https://ODC_PORTAL_DOMAIN/api/asset-configurations/v1
description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/asset-configurations/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:
- Environments
summary: Gets the configurations of an agent.
description: 'Returns the agent configurations for the deployed revision.
API Client needs the **Configuration management > View configurations** permission for the target environment (stage).'
operationId: AssetConfiguration_GetAgentDeployedConfiguration
parameters:
- name: environmentKey
in: path
description: The environment's key.
required: true
schema:
type: string
- name: agentKey
in: path
description: The agent's key.
required: true
schema:
type: string
- name: fields
in: query
description: 'Comma-separated list of fields to include. Allowed values: systemConfigurations, settings, timers, integrations, libraries.'
schema:
type: string
- name: showBinaryValues
in: query
description: Specifies whether to return the binary values.
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AgentConfigResult'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-os-permissions: API Client needs the **Configuration management > View configurations** permission for the target environment (stage).
/environments/{environmentKey}/agents/{agentKey}/revisions/{baselineRevision}/configurations:
servers:
- url: https://ODC_PORTAL_DOMAIN/api/asset-configurations/v1
description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/asset-configurations/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:
- Environments
summary: Gets the configurations of an agent revision.
description: 'Returns the configurations for a specific revision of an agent.
API Client needs the **Configuration management > View configurations** permission for the target environment (stage).'
operationId: AssetConfiguration_GetAgentRevisionConfiguration
parameters:
- name: environmentKey
in: path
description: The environment's key.
required: true
schema:
type: string
- name: agentKey
in: path
description: The agent's key.
required: true
schema:
type: string
- name: fields
in: query
description: 'Comma-separated list of fields to include. Allowed values: systemConfigurations, settings, timers, integrations, libraries.'
schema:
type: string
- name: baselineRevision
in: path
description: The agent revision.
required: true
schema:
type: string
- name: showBinaryValues
in: query
description: Specifies whether to return the binary values.
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AgentConfigResult'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-os-permissions: API Client needs the **Configuration management > View configurations** permission for the target environment (stage).
/environments/{environmentKey}/applications/{applicationKey}/revisions/deployed/configurations:
servers:
- url: https://ODC_PORTAL_DOMAIN/api/asset-configurations/v1
description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/asset-configurations/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:
- Environments
summary: Gets the configurations of an app.
description: 'Returns the app configurations for the deployed revision.
API Client needs the **Configuration management > View configurations** permission for the target environment (stage).'
operationId: AssetConfiguration_GetApplicationDeployedConfiguration
parameters:
- name: environmentKey
in: path
description: The environment's key.
required: true
schema:
type: string
- name: applicationKey
in: path
description: The app's key.
required: true
schema:
type: string
- name: fields
in: query
description: 'Comma-separated list of fields to include. Allowed values: systemConfigurations, settings, timers, integrations, libraries.'
schema:
type: string
- name: showBinaryValues
in: query
description: Specifies whether to return the binary values.
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationConfigResult'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-os-permissions: API Client needs the **Configuration management > View configurations** permission for the target environment (stage).
/environments/{environmentKey}/applications/{applicationKey}/revisions/{baselineRevision}/configurations:
servers:
- url: https://ODC_PORTAL_DOMAIN/api/asset-configurations/v1
description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/asset-configurations/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:
- Environments
summary: Gets the configurations of an app revision.
description: 'Returns the app configurations for a given revision.
API Client needs the **Configuration management > View configurations** permission for the target environment (stage).'
operationId: AssetConfiguration_GetApplicationRevisionConfiguration
parameters:
- name: environmentKey
in: path
description: The environment's key.
required: true
schema:
type: string
- name: applicationKey
in: path
description: The app's key.
required: true
schema:
type: string
- name: fields
in: query
description: 'Comma-separated list of fields to include. Allowed values: systemConfigurations, settings, timers, integrations, libraries.'
schema:
type: string
- name: baselineRevision
in: path
description: The app revision.
required: true
schema:
type: string
- name: showBinaryValues
in: query
description: Specifies whether to return the binary values.
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationConfigResult'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-os-permissions: API Client needs the **Configuration management > View configurations** permission for the target environment (stage).
/environments/{environmentKey}/agents/{agentKey}/configurations:
servers:
- url: https://ODC_PORTAL_DOMAIN/api/asset-configurations/v1
description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/asset-configurations/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
patch:
tags:
- Environments
summary: Updates the configurations of an agent.
description: 'Updates the configuration values for an agent. Only the provided elements are changed.
API Client needs the **Configuration management > Edit configurations** permission for the target environment (stage).'
operationId: AssetConfiguration_PatchAgent
parameters:
- name: environmentKey
in: path
description: The environment's key.
required: true
schema:
type: string
- name: agentKey
in: path
description: The agent's key.
required: true
schema:
type: string
requestBody:
description: Configurations to patch in
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AgentConfigPatch'
application/*+json:
schema:
allOf:
- $ref: '#/components/schemas/AgentConfigPatch'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-os-permissions: API Client needs the **Configuration management > Edit configurations** permission for the target environment (stage).
/environments/{environmentKey}/applications/{applicationKey}/configurations:
servers:
- url: https://ODC_PORTAL_DOMAIN/api/asset-configurations/v1
description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/asset-configurations/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
patch:
tags:
- Environments
summary: Updates the configurations of an app.
description: 'Updates the configuration values for an app. Only the provided elements are changed.
API Client needs the **Configuration management > Edit configurations** permission for the target environment (stage).'
operationId: AssetConfiguration_PatchApplication
parameters:
- name: environmentKey
in: path
description: The environment's key.
required: true
schema:
type: string
- name: applicationKey
in: path
description: The app's key.
required: true
schema:
type: string
requestBody:
description: Configurations to patch in
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplicationConfigPatch'
application/*+json:
schema:
allOf:
- $ref: '#/components/schemas/ApplicationConfigPatch'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-os-permissions: API Client needs the **Configuration management > Edit configurations** permission for the target environment (stage).
/environments/{environmentKey}/default-system-configurations:
servers:
- url: https://ODC_PORTAL_DOMAIN/api/asset-configurations/v1
description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/asset-configurations/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:
- Environments
summary: Gets the default system configurations for an environment (stage)
description: 'Returns the default system configurations for an environment (stage).
API Client needs the **Configuration management > View configurations** permission for the target environment (stage).'
operationId: EnvironmentConfiguration_Get
parameters:
- name: environmentKey
in: path
description: The environment's key.
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentConfigResult'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-os-permissions: API Client needs the **Configuration management > View configurations** permission for the target environment (stage).
patch:
tags:
- Environments
summary: Updates the default system configurations of an environment (stage).
description: 'Updates the default system configuration values for an environment. Only the provided elements are changed.
To update configurations, API Client needs the **Configuration management > Edit configurations** permission for the target environment (stage).
To update email configurations, API Client needs the **Configuration management > Manage Email SMTP configuration** permission for the target environment (stage).'
operationId: EnvironmentConfiguration_Patch
parameters:
- name: environmentKey
in: path
description: The environment's key.
required: true
schema:
type: string
requestBody:
description: Environment configurations to be changed
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/EnvironmentConfigPatch'
application/*+json:
schema:
allOf:
- $ref: '#/components/schemas/EnvironmentConfigPatch'
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-os-permissions: 'To update configurations, API Client needs the **Configuration management > Edit configurations** permission for the target environment (stage).
To update email configurations, API Client needs the **Configuration management > Manage Email SMTP configuration** permission for the target environment (stage).'
/environments:
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:
- Environments
summary: Retrieves the list of environments (stages).
description: 'Deprecated since 2026-07-08. Use GET /portfolios/v2/environments instead. Note that V2''s
EnvironmentsController does not use the in-memory response caching this V1 endpoint has.
This endpoint will be removed on or after 2027-01-08.
The result only shows environments (stages) for which the API Client has **Stage > View stage** permission.'
operationId: Environments_ListEnvironments
responses:
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails_2'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails_2'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails_2'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails_2'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentListResponse'
deprecated: true
x-os-permissions: The result only shows environments (stages) for which the API Client has **Stage > View stage** permission.
patch:
tags:
- Environments
summary: Updates environment names and/or order
operationId: Environments_UpdateEnvironments
requestBody:
description: Batch update request
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateEnvironmentsBatchRequest'
description: Batch request to update multiple environments
application/*+json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateEnvironmentsBatchRequest'
description: Batch request to update multiple environments
responses:
'200':
description: OK
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails_3'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails_3'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails_3'
'422':
description: Unprocessable Content
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails_3'
x-os-permissions: Requires **Portfolio management > Manage stages** permission for environments when changing name only, and **Portfolio management > Manage portfolio** when changing order.
description: '
Requires **Portfolio management > Manage stages** permission for environments when changing name only, and **Portfolio management > Manage portfolio** when changing order.'
/environments/{environmentKey}:
servers:
- 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
patch:
tags:
- Environments
summary: Updates a single environment's name and/or order
operationId: Environments_PatchEnvironment
parameters:
- name: environmentKey
in: path
description: The environment key to update
required: true
schema:
type: string
format: uuid
requestBody:
description: Patch request with name and/or order
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PatchEnvironmentRequest'
description: Request to update a single environment's properties
application/*+json:
schema:
allOf:
- $ref: '#/components/schemas/PatchEnvironmentRequest'
description: Request to update a single environment's properties
responses:
'200':
description: OK
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails_3'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails_3'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails_3'
'422':
description: Unprocessable Content
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails_3'
x-os-permissions: Requires **Portfolio management > Manage stages** permission for environments when changing name only, and **Portfolio management > Manage portfolio** when changing order.
description: '
Requires **Portfolio management > Manage stages** permission for environments when changing name only, and **Portfolio management > Manage portfolio** when changing order.'
/environments/{environmentKey}/entitlements/usage/by-asset:
servers:
- url: https://ODC_PORTAL_DOMAIN/api/subscription/v1
description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/subscription/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:
- Environments
summary: Retrieves usage data per asset (application, library) for entitlements in a specific environment.
description: 'Paginated; supports filtering and sort by metric.
To fetch the usage, API Client needs the **Stage > View stage** and **Subscriptions > View subscription** permissions in the target stage.'
operationId: Subscription_GetAssetUsage
parameters:
- name: environmentKey
in: path
description: Environment key
required: true
schema:
type: string
- name: entitlementIds
in: query
description: 'Optional comma-separated entitlement IDs. Valid values: applicationObjects, maxComputeReplicas, maxCustomCodeTotalDuration, agentExecutions'
schema:
type: string
- name: assetKeys
in: query
description: Optional comma-separated asset keys (GUIDs) to filter results
schema:
type: string
- name: assetName
in: query
description: Optional partial or full asset name for case-insensitive search
schema:
type: string
- name: detailKey
in: query
description: Optional filter by detail key
schema:
type: string
- name: detailName
in: query
description: Optional filter by detail name (case-insensitive partial match)
schema:
type: string
- name: sortBy
in: query
description: 'Comma-separated metrics to sort by. Prefix with ''+'' for ascending (default) or ''-'' for descending. Example: "applicationObjects,-maxComputeReplicas"'
schema:
type: string
- name: since
in: query
description: Start date for usage data (ISO 8601 format)
schema:
type: string
- name: to
in: query
description: End date for usage data (ISO 8601 format)
schema:
type: string
- name: limit
in: query
description: 'Maximum number of asset rows to return. Default: 100.'
schema:
type: integer
format: int32
- name: offset
in: query
description: 'Number of asset rows to skip for pagination. Default: 0.'
schema:
type: integer
format: int32
- name: aggregations
in: query
description: 'Optional comma-separated aggregation functions. Valid values: Total, Max, P95, P90'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UnifiedEntitlementByAssetBlockPagedListResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-os-permissions: To fetch the usage, API Client needs the **Stage > View stage** and **Subscriptions > View subscription** permissions in the target stage.
/environments/{environmentKey}/entitlements:
servers:
- url: https://ODC_PORTAL_DOMAIN/api/subscription/v1
description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/subscription/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:
- Environments
summary: Retrieves information on the entitlements for a specific environment.
description: 'Entitlements and add-ons are shown with sufficient permissions.
To fetch the entitlements, API Client needs the **Stage > View stage** permission in the target stage.
To additionally fetch the add-ons, API Client a
# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/openapi/outsystems-environments-api-openapi.yml