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 AwsCredentials API

The AwsCredentials API from Radius — 2 operation(s) for awscredentials.

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

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

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

AwsCredentials 5
GET
/planes/aws/{planeName}/providers/System.AWS/credentials
List AWS credentials
AwsCredentials_List 2 params → 200default
GET
/planes/aws/{planeName}/providers/System.AWS/credentials/{credentialName}
Get an AWS credential
AwsCredentials_Get 3 params → 200default
PUT
/planes/aws/{planeName}/providers/System.AWS/credentials/{credentialName}
Create or update an AWS credential
AwsCredentials_CreateOrUpdate 4 params → 200201default
PATCH
/planes/aws/{planeName}/providers/System.AWS/credentials/{credentialName}
Update an AWS credential
AwsCredentials_Update 4 params → 200default
DELETE
/planes/aws/{planeName}/providers/System.AWS/credentials/{credentialName}
Delete an AWS credential
AwsCredentials_Delete 3 params → 200204default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are AwsCredentialResourceListResult (2 properties), AwsCredentialProperties (2 properties), AwsCredentialResource (1 property), AwsCredentialResourceTagsUpdate (1 property). Each schema is shown below with its type and property counts.

AWSCredentialKind
string
AWS credential kind
AwsCredentialResourceTagsUpdate
object
The type used for updating tags in AwsCredentialResource resources.
1 property
AwsCredentialProperties
object
AWS Credential properties
2 properties 1 required
AwsCredentialResource
object
Concrete tracked resource types can be created by aliasing this type using a specific property type.
1 property 1 required
ProvisioningState
string
Provisioning state of the resource at the time the operation was called
AwsCredentialResourceListResult
object
The response of a AwsCredentialResource list operation.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

radius-awscredentials-api-openapi.yml Raw ↑

Other APIs Radius publishes across the network.

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