HomeGuidesAPI Reference
API Reference

Register a new AWS account for cloud deployment

Registers a new AWS account with the Orchestrator for cloud deployment operations. The account credentials are validated against AWS before being stored. The secret key is encrypted before storage.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

AWS account configuration containing credentials and metadata. The id field is auto-generated and should not be provided.

AWS account configuration for cloud deployment operations. Contains credentials and metadata for authenticating with AWS services.

string
required
length ≥ 1

Unique display name for the AWS account. Used for identification in the UI and API responses. Must not conflict with existing account names.

string
required
length ≥ 1
^[A-Z0-9]{16,128}$

AWS IAM access key ID for API authentication. Typically starts with 'AKIA' for long-term credentials.

string
required
length ≥ 1

AWS IAM secret access key paired with the access key. Encrypted before storage. Not returned in GET responses for security.

string

Optional description or notes for the AWS account. Useful for documenting the account purpose or environment.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json