OutSystems

OutSystems Environments API

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

GitHub OpenAPI

Operations 54

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

GET /environments/{environmentKey}/agents/{agentKey}/revisions/deployed/configurations Get a deployed agent's configurations · Gets the configurations of an agent #
Ask an LLM
“What settings and timers is my deployed agent currently running with?”
“Can I see binary configuration values for an agent in a stage?”
Tell an agent
Get the deployed configurations of agent {agentKey} in stage {environmentKey}.
Show the live settings of agent {agentKey} in environment {environmentKey}.
GET /environments/{environmentKey}/agents/{agentKey}/revisions/{baselineRevision}/configurations Get configurations of an agent revision · Gets the configurations of an agent revision #
Ask an LLM
“How do I see the configurations for a specific revision of an agent, not the deployed one?”
“Can I compare an agent revision's settings before I deploy it?”
Tell an agent
Get configurations of agent {agentKey} revision {baselineRevision} in stage {environmentKey}.
Show the settings agent {agentKey} would use at revision {baselineRevision} in {environmentKey}.
GET /environments/{environmentKey}/applications/{applicationKey}/revisions/deployed/configurations Get a deployed app's configurations · Gets the configurations of an app #
Ask an LLM
“What site settings and integrations is my deployed app using in a stage?”
“Can I read the live configuration values of an app in production?”
Tell an agent
Get the deployed configurations of app {applicationKey} in stage {environmentKey}.
Show the live settings of app {applicationKey} in environment {environmentKey}.
GET /environments/{environmentKey}/applications/{applicationKey}/revisions/{baselineRevision}/configurations Get configurations of an app revision · Gets the configurations of an app revision #
Ask an LLM
“How do I see an app's configurations for a revision that isn't deployed yet?”
“Which settings does a given app revision define in a stage?”
Tell an agent
Get configurations of app {applicationKey} revision {baselineRevision} in stage {environmentKey}.
Show what settings app {applicationKey} has at revision {baselineRevision} in {environmentKey}.
PATCH /environments/{environmentKey}/agents/{agentKey}/configurations Update an agent's configurations · Updates the configurations of an agent #
Ask an LLM
“How do I change settings or timers for an agent in a stage?”
“Does updating an agent's configuration change only the values I send?”
Tell an agent
Update the settings of agent {agentKey} in stage {environmentKey} to {settings}.
Change the timers of agent {agentKey} in {environmentKey} to {timers}.
PATCH /environments/{environmentKey}/applications/{applicationKey}/configurations Update an app's configurations · Updates the configurations of an app #
Ask an LLM
“How do I change an app's settings or integration endpoints in one stage?”
“Can I override system configurations for a single app?”
Tell an agent
Update the settings of app {applicationKey} in stage {environmentKey} to {settings}.
Change the integrations of app {applicationKey} in {environmentKey} to {integrations}.
GET /environments/{environmentKey}/default-system-configurations Get a stage's default system configurations · Gets the default system configurations for an environment (stage) #
Ask an LLM
“What default system configurations apply to every app in a stage?”
“Where can I see a stage's baseline system settings?”
Tell an agent
Get the default system configurations of stage {environmentKey}.
Show environment {environmentKey}'s default system settings.
PATCH /environments/{environmentKey}/default-system-configurations Update a stage's default system configurations · Updates the default system configurations of an environment (stage) #
Ask an LLM
“How do I change the default system configurations for a whole stage?”
“Are omitted default system settings left unchanged when I update a stage?”
Tell an agent
Update the default system configurations of stage {environmentKey} to {systemConfigurations}.
Set environment {environmentKey}'s stage-wide system defaults to {systemConfigurations}.
GET /environments List environments (stages) · Retrieves the list of environments (stages) #
Ask an LLM
“What stages, like Development, QA and Production, do I have in ODC?”
“Can I list only the stages that belong to one portfolio?”
Tell an agent
List all my environments.
List the stages in portfolio {portfolioKey}.
PATCH /environments Rename or reorder several stages · Updates environment names and/or order #
Ask an LLM
“Can I rename and reorder multiple stages in one request?”
“What permission do I need to change the order of my stages?”
Tell an agent
Update these stages' names and order: {environments}.
Reorder all my stages as {environments}.
PATCH /environments/{environmentKey} Rename or reposition one stage · Updates a single environment's name and/or order #
Ask an LLM
“How do I rename a single stage?”
“Can I move one stage to a different position in the pipeline order?”
Tell an agent
Rename stage {environmentKey} to {name}.
Move stage {environmentKey} to position {order}.
GET /environments/{environmentKey}/entitlements/usage/by-asset Get entitlement usage per asset in a stage · Retrieves usage data per asset (application, library) for entitlements in a… #
Ask an LLM
“Which apps or libraries consume the most of my entitlements in a stage?”
“Can I break a stage's usage down by asset and sort by a metric?”
Tell an agent
Show entitlement usage per asset in stage {environmentKey}.
Get usage by asset in {environmentKey} for entitlements {entitlementIds} since {since}.
GET /environments/{environmentKey}/entitlements Get a stage's entitlements · Retrieves information on the entitlements for a specific environment #
Ask an LLM
“What entitlements and add-ons does a specific stage have?”
“Which limits apply to one environment under my subscription?”
Tell an agent
Get the entitlements of stage {environmentKey}.
Show the add-ons and entitlements for environment {environmentKey}.
GET /environments/{environmentKey}/entitlements/usage Get entitlement usage for a stage · Retrieves usage data for entitlements in a specific environment #
Ask an LLM
“How much of its entitlements has a stage used over a date range?”
“Can I see a stage's usage aggregated daily or monthly?”
Tell an agent
Show entitlement usage for stage {environmentKey}.
Get usage for {environmentKey} between {since} and {to} at {granularity} granularity.
POST /environments/ Register the environment in LifeTime #
GET /environments/ Lists all the environments in the infrastructure #
DELETE /environments/{EnvironmentKey} Unregister the environment in LifeTime #
GET /environments/{EnvironmentKey}/ Returns the details of a given environment #
GET /environments/{EnvironmentKey}/applications/ Returns information about the running versions of all applications in a given… #
POST /environments/{EnvironmentKey}/applications/ Creates a new application #
GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/ Returns information about the running version of the specified application in a… #
GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/content/ Returns a link where the binary file for a given application can be downloaded #
POST /environments/{EnvironmentKey}/applications/{ApplicationKey}/sourcecodeaccess/ Request the creation of the source code package of the application to be… #
GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/sourcecodeaccess/{PackageKey}/download/ Returns a link where the source code package can be downloaded #
GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/sourcecodeaccess/{PackageKey}/status/ Returns the details of a given source code packaging execution, including the… #
POST /environments/{EnvironmentKey}/applications/{ApplicationKey}/versions/ Creates a new version of the application based on the current running instance #
POST /environments/{EnvironmentKey}/modules/{ModuleKey}/sourcecodeaccess/ Request the creation of the source code package of the module to be downloaded #
GET /environments/{EnvironmentKey}/modules/{ModuleKey}/sourcecodeaccess/{PackageKey}/download/ Returns a link where the module's source code package can be downloaded #
GET /environments/{EnvironmentKey}/modules/{ModuleKey}/sourcecodeaccess/{PackageKey}/status/ Returns the details of a given module's source code packaging execution… #
GET /environments/{EnvironmentKey}/deploymentzones/ Returns information about the deployment zones available in a given environment #
PUT /environments/{EnvironmentKey}/maintenancemode Sets the maintenance mode (true or false) of a given environment #
GET /environments/{EnvironmentKey}/templates/ Returns information about the templates available in a given environment #
GET /environments/{EnvironmentKey}/content_security_policies/ Returns information about the content security policies in a given environment #
PUT /environments/{EnvironmentKey}/content_security_policies/ Sets the Content Security Policies for a given environment #
GET /environments/{EnvironmentKey}/dbconnections/ Returns all the DB connections of a given environment #
POST /environments/{EnvironmentKey}/dbconnections/ Creates a new DB connection for an environment #
GET /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/ Returns the detail of a DB connection for a given environment #
PUT /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/ Updates a DB connection for an environment #
DELETE /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/ Deletes a DB connection for an environment #
PUT /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/rolepermissionlevel/ Sets the DB connection permission levels for a Role in a given environment #
DELETE /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/rolepermissionlevel/ Revokes the DB connection permissions for a Role in an environment #
GET /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/rolepermissionlevel/{Role}/ Returns the DB connection permission level of a Role for a given environment #
PUT /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/userpermissionlevel/ Sets the DB connection permission levels for a User in a given environment #
DELETE /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/userpermissionlevel/ Revokes the DB connection permissions for a User in an environment #
GET /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/userpermissionlevel/{Username}/ Returns the DB connection permission level of a User for a given environment #
GET /environments/{EnvironmentKey}/dbconnection/dbproviders/ Returns the list of providers for all the DB connections in a given environment #
POST /environments/{EnvironmentKey}/deployment/ Creates a deployment of a binary to a target environment #
GET /environments/dbconnection/permissionlevels/ Returns the permission levels for the DB connections #
POST /environments/{EnvironmentKey}/testdbconnection/ Tests the DB connection #
GET /environments/blockedipaddresses/ Gets the IP addresses blocked login attempts #
DELETE /environments/blockedipaddresses/{IPAddress}/ Unblocks a given IP Address #
POST /environments/{EnvironmentKey}/solution Creates a temporary solution #
GET /environments/{EnvironmentKey}/solution/{SolutionKey} Download the given solution #
GET /environments/{EnvironmentKey}/solutionstatus/{SolutionKey} Returns the status of the solution being created #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/openapi/outsystems-environments-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-application-config-result-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-agent-config-result-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-application-config-patch-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-agent-config-patch-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-unified-entitlement-by-asset-block-paged-list-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-environment-entitlements-schema.json

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/outsystems:outsystems-environments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

outsystems-environments-api-openapi.yml Raw ↑ 
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-v2-openapi.json, outsystems-subscription-api-v1-openapi.json, lifetime-api.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/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
- url: /lifetimeapi/rest/v2
tags:


# --- truncated at 32 KB (166 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/openapi/outsystems-environments-api-openapi.yml