Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Radius

Radius Environments API

The Environments API from Radius — 3 operation(s) for environments.

Documentation Provider Profile APIs.io OpenAPI GitHub

Radius Environments API is one of 27 APIs that Radius 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 and API documentation.

This API exposes 6 operations across 3 paths, and defines 26 schemas. It is described by OpenAPI 2.0, at version 2023-10-01-preview.

Requests are made against the base URL https://management.azure.com.

6 operations 3 paths 26 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-10-01-preview
Base URL
https://management.azure.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Radius Environments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (azure_auth) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

  • azure_auth — Azure Active Directory OAuth2 Flow.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Environments 6
GET
/{rootScope}/providers/Applications.Core/environments
List EnvironmentResource resources by Scope
Environments_ListByScope 2 params → 200default
GET
/{rootScope}/providers/Applications.Core/environments/{environmentName}
Get a EnvironmentResource
Environments_Get 3 params → 200default
PUT
/{rootScope}/providers/Applications.Core/environments/{environmentName}
Create a EnvironmentResource
Environments_CreateOrUpdate 4 params → 200201default
PATCH
/{rootScope}/providers/Applications.Core/environments/{environmentName}
Update a EnvironmentResource
Environments_Update 4 params → 200default
DELETE
/{rootScope}/providers/Applications.Core/environments/{environmentName}
Delete a EnvironmentResource
Environments_Delete 3 params → 200204default
POST
/{rootScope}/providers/Applications.Core/environments/{environmentName}/getMetadata
Gets recipe metadata including parameters and any constraints on the parameters.
Environments_GetMetadata 4 params → 200default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are EnvironmentProperties (7 properties), RecipeGetMetadataResponse (5 properties), IdentitySettings (4 properties), RecipeConfigProperties (4 properties). Each schema is shown below with its type and property counts.

EnvironmentProperties
object
Environment properties
7 properties 1 required
EnvironmentResourceListResult
object
The response of a EnvironmentResource list operation.
2 properties 1 required
SecretReference
object
This secret is used within a recipe. Secrets are encrypted, often have fine-grained access control, auditing and are recommended to be used to hold sensitive d…
2 properties 2 required
ProvidersAws
object
The AWS cloud provider definition.
1 property 1 required
EnvironmentResource
object
The environment resource
1 property 1 required
EnvironmentCompute
object
Represents backing compute resource
3 properties 1 required
IdentitySettingKind
string
IdentitySettingKind is the kind of supported external identity setting
RecipeProperties
object
Format of the template provided by the recipe. Allowed values: bicep, terraform.
3 properties 2 required
ProvidersAzure
object
The Azure cloud provider definition.
1 property 1 required
GitAuthConfig
object
Authentication information used to access private Terraform modules from Git repository sources.
1 property
RegistrySecretConfig
object
Registry Secret Configuration used to authenticate to private bicep registries.
1 property
TerraformConfigProperties
object
Configuration for Terraform Recipes. Controls how Terraform plans and applies templates as part of Recipe deployment.
2 properties
SecretConfig
object
Personal Access Token (PAT) configuration used to authenticate to Git platforms.
1 property
ProviderConfigProperties
object
This configuration holds the necessary information to authenticate and interact with a provider for the recipe execution.
1 property
Azure.ResourceManager.CommonTypes.TrackedResourceUpdate
object
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
1 property
RecipeConfigProperties
object
Configuration for Recipes. Defines how each type of Recipe should be configured and run.
4 properties
BicepConfigProperties
object
Configuration for Bicep Recipes. Controls how Bicep plans and applies templates as part of Recipe deployment.
1 property
RecipeGetMetadataResponse
object
The properties of a Recipe linked to an Environment.
5 properties 3 required
AuthConfig
object
Authentication information used to access private Terraform module sources. Supported module sources: Git.
1 property
EnvironmentResourceUpdate
object
The environment resource
RecipeGetMetadata
object
Represents the request body of the getmetadata action.
2 properties 2 required
ProvisioningState
string
Provisioning state of the resource at the time the operation was called
IdentitySettings
object
IdentitySettings is the external identity setting.
4 properties 1 required
EnvironmentVariables
object
The environment variables injected during Terraform Recipe execution for the recipes in the environment.
Providers
object
The Cloud providers configuration.
2 properties
Extension
object
Extension of a environment/application resource.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

radius-environments-api-openapi.yml Raw ↑

Other APIs Radius publishes across the network.

Radius ApiVersions API
AE Profile APIs.io
Radius Applications API
AE Profile APIs.io
Radius AwsCredentials API
AE Profile APIs.io
Radius AwsPlanes API
AE Profile APIs.io
Radius AzureCredentials API
AE Profile APIs.io
Radius AzurePlanes API
AE Profile APIs.io
Radius ConfigurationStores API
AE Profile APIs.io
Radius Containers API
AE Profile APIs.io
Radius Extenders API
AE Profile APIs.io
Radius Gateways API
AE Profile APIs.io
Radius Locations API
AE Profile APIs.io
Radius MongoDatabases API
AE Profile APIs.io
#Environments
← Back to R APIs
API Details
ID
radius:radius-environments-api
Base URL
https://management.azure.com
Docs
https://docs.radapp.io/reference/api/applications.core/
Provider
Radius
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network