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

Radius Gateways API

The Gateways API from Radius — 2 operation(s) for gateways.

Radius Gateways API is one of 27 APIs that Radius publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Gateways. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 16 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.

5 operations 2 paths 16 schemas 1 DELETE2 GET1 PATCH1 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 Gateways 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 5

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

Gateways 5
GET
/{rootScope}/providers/Applications.Core/gateways
List GatewayResource resources by Scope
Gateways_ListByScope 2 params → 200default
GET
/{rootScope}/providers/Applications.Core/gateways/{gatewayName}
Get a GatewayResource
Gateways_Get 3 params → 200default
PUT
/{rootScope}/providers/Applications.Core/gateways/{gatewayName}
Create a GatewayResource
Gateways_Create 4 params → 200201default
PATCH
/{rootScope}/providers/Applications.Core/gateways/{gatewayName}
Update a GatewayResource
Gateways_CreateOrUpdate 4 params → 200202default
DELETE
/{rootScope}/providers/Applications.Core/gateways/{gatewayName}
Delete a GatewayResource
Gateways_Delete 3 params → 202204default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are GatewayProperties (9 properties), GatewayRoute (5 properties), IdentitySettings (4 properties), GatewayTls (3 properties). Each schema is shown below with its type and property counts.

GatewayResourceUpdate
object
Concrete tracked resource types can be created by aliasing this type using a specific property type.
GatewayTls
object
TLS configuration definition for Gateway resource.
3 properties
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
GatewayHostname
object
Declare hostname information for the Gateway. Leaving the hostname empty auto-assigns one: mygateway.myapp.PUBLICHOSTNAMEORIP.nip.io.
2 properties
GatewayProperties
object
Gateway properties
9 properties 2 required
ResourceStatus
object
Status of a resource.
3 properties
ProvisioningState
string
Provisioning state of the resource at the time the operation was called
GatewayResource
object
Concrete tracked resource types can be created by aliasing this type using a specific property type.
1 property 1 required
IdentitySettings
object
IdentitySettings is the external identity setting.
4 properties 1 required
RecipeStatus
object
Recipe status at deployment time for a resource.
3 properties 2 required
GatewayRoute
object
Route attached to Gateway
5 properties
OutputResource
object
Properties of an output resource.
3 properties
EnvironmentCompute
object
Represents backing compute resource
3 properties 1 required
IdentitySettingKind
string
IdentitySettingKind is the kind of supported external identity setting
GatewayResourceListResult
object
The response of a GatewayResource list operation.
2 properties 1 required
GatewayRouteTimeoutPolicy
object
Gateway route timeout policy
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

radius-gateways-api-openapi.yml Raw ↑

Other APIs Radius publishes across the network.

Radius ApiVersions API
Radius Applications API
Radius AwsCredentials API
Radius AwsPlanes API
Radius AzureCredentials API
Radius AzurePlanes API
Radius ConfigurationStores API
Radius Containers API
Radius Environments API
Radius Extenders API
Radius Locations API
Radius MongoDatabases API