How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OutSystems Environments API

The Environments API from OutSystems — 12 operation(s) for environments.

OutSystems Environments API is one of 37 APIs that OutSystems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Environments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 14 operations across 12 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 8 base URLs: https://ODC_PORTAL_DOMAIN/api/asset-configurations/v1, https://{odc-portal-domain}/api/asset-configurations/v1, https://ODC_PORTAL_DOMAIN/api/portfolios/v1, https://{odc-portal-domain}/api/portfolios/v1, https://ODC_PORTAL_DOMAIN/api/portfolios/v2, https://{odc-portal-domain}/api/portfolios/v2, https://ODC_PORTAL_DOMAIN/api/subscription/v1, https://{odc-portal-domain}/api/subscription/v1.

14 operations 12 paths 37 schemas 9 GET5 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{odc-portal-domain}/api/identity/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

OutSystems Environments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Enter your bearer token in the format 'Bearer {token}'

Paths & Operations 14

Across 12 paths, the API surfaces 14 operations — 9 GET, 5 PATCH. Each is listed below with its method, path, parameters, and response codes.

Environments 14
GET
/environments/{environmentKey}/agents/{agentKey}/revisions/deployed/configurations
Gets the configurations of an agent.
AssetConfiguration_GetAgentDeployedConfiguration 4 params → 200401403404
GET
/environments/{environmentKey}/agents/{agentKey}/revisions/{baselineRevision}/configurations
Gets the configurations of an agent revision.
AssetConfiguration_GetAgentRevisionConfiguration 5 params → 200401403404
GET
/environments/{environmentKey}/applications/{applicationKey}/revisions/deployed/configurations
Gets the configurations of an app.
AssetConfiguration_GetApplicationDeployedConfiguration 4 params → 200401403404
GET
/environments/{environmentKey}/applications/{applicationKey}/revisions/{baselineRevision}/configurations
Gets the configurations of an app revision.
AssetConfiguration_GetApplicationRevisionConfiguration 5 params → 200401403404
PATCH
/environments/{environmentKey}/agents/{agentKey}/configurations
Updates the configurations of an agent.
AssetConfiguration_PatchAgent 2 params body → 204400401403404
PATCH
/environments/{environmentKey}/applications/{applicationKey}/configurations
Updates the configurations of an app.
AssetConfiguration_PatchApplication 2 params body → 204400401403404
GET
/environments/{environmentKey}/default-system-configurations
Gets the default system configurations for an environment (stage)
EnvironmentConfiguration_Get 1 param → 200401403404
PATCH
/environments/{environmentKey}/default-system-configurations
Updates the default system configurations of an environment (stage).
EnvironmentConfiguration_Patch 1 param body → 204401403404
GET
/environmentsdeprecated
Retrieves the list of environments (stages).
Environments_ListEnvironments → 401400403429200
PATCH
/environments
Updates environment names and/or order
Environments_UpdateEnvironments body → 200400403404422
PATCH
/environments/{environmentKey}
Updates a single environment's name and/or order
Environments_PatchEnvironment 1 param body → 200400403404422
GET
/environments/{environmentKey}/entitlements/usage/by-asset
Retrieves usage data per asset (application, library) for entitlements in a specific environment.
Subscription_GetAssetUsage 12 params → 200401403404
GET
/environments/{environmentKey}/entitlements
Retrieves information on the entitlements for a specific environment.
Subscription_GetEnvironmentEntitlements 1 param → 401403404200
GET
/environments/{environmentKey}/entitlements/usage
Retrieves usage data for entitlements in a specific environment.
Subscription_GetEnvironmentUsage 7 params → 200401403404

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are GenericConfigResult (13 properties), ApplicationConfigResult (10 properties), Addon (9 properties), Environment (9 properties). Each schema is shown below with its type and property counts.

ProblemDetails_3
object
A standardized error response as per RFC 7807 (Problem Details for HTTP APIs).
7 properties
UsageDataPoint
object
Represents a single data point in a usage time series.
3 properties
LibraryConfigResult
object
7 properties
PatchEnvironmentRequest
object
Request to update a single environment's properties
2 properties
PageInfoWithTotals
object
Contains response page information including totals.
6 properties
UnifiedEntitlementAssetRow
object
Represents a single asset row with entitlement usage value.
6 properties
DataType_2
string
Data type of the value of an addon or entitlement.
ProblemDetails
object
A standardized error response as per RFC 7807 (Problem Details for HTTP APIs).
7 properties
EntitlementUsageItemListResponse
object
Represents a response containing a list of results.
1 property
UpdateEnvironmentRequest
object
Request to update environment properties
3 properties 1 required
TimerResult
object
4 properties
Origin
string
Entitlement
object
Represents the Entitlement information.
8 properties
UnifiedEntitlementByAssetBlock
object
Represents usage data for a single entitlement type, with breakdown by assets.
4 properties
IntegrationResult
object
4 properties
AgentConfigResult
object
9 properties
ApplicationConfigResult
object
10 properties
ApplicationConfigPatch
object
7 properties
EnvironmentEntitlements
object
Represents the entitlements present in an environment
2 properties
TimerPatch
object
2 properties
Environment
object
Environment
9 properties
EnvironmentPurpose
string
GenericConfigPatch
object
3 properties
UnifiedEntitlementDetailRow
object
Represents a detail-level breakdown within an asset's entitlement usage.
4 properties
IntegrationPatch
object
2 properties
Addon
object
Represents the Add-on information.
9 properties
UnifiedEntitlementByAssetBlockPagedListResponse
object
Represents a response containing a paged set of results.
2 properties
EnvironmentConfigPatch
object
1 property
ProblemDetails_2
object
A standardized error response as per RFC 7807 (Problem Details for HTTP APIs).
7 properties
DataType
string
EnvironmentListResponse
object
Represents a response containing a list of results.
1 property
EnvironmentConfigResult
object
1 property
EntitlementUsageItem
object
Represents usage data for a single entitlement type.
5 properties
LibraryConfigPatch
object
5 properties
GenericConfigResult
object
13 properties
UpdateEnvironmentsBatchRequest
object
Batch request to update multiple environments
1 property 1 required
AgentConfigPatch
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

outsystems-environments-api-openapi.yml Raw ↑

Other APIs OutSystems publishes across the network.

OutSystems Remote MCP Server
OutSystems Analysis Status API
OutSystems Application Roles API
OutSystems Assets API
OutSystems Assets Quality Metrics API
OutSystems Build API
OutSystems Build Operations API
OutSystems Code Analyses API
OutSystems Deletion Analyses API
OutSystems Deployed Assets API
OutSystems Deployment Analyses API
OutSystems Deployment Operations API
Where this information came from

This is an independent, third-party profile of OutSystems Environments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.