Returns AWS image for the specified AMI name

POST 
https://api.spectrocloud.com/v1/clouds/aws/regions/:region/images

Returns AWS image for the specified AMI name

Request

Path Parameters

region stringrequired

Region to find AWS image

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

Request payload to find the AWS image

amiNamestring

AWS image ami name

awsAccount

object

AWS cloud account which includes access key and secret key in case of 'secret' credentials type. It includes policyARNS, ARN and externalId in case of sts. Partition is a group of AWS Region and Service objects

accessKeystring

AWS account access key

credentialTypestring

Possible values: [secret, sts]

Default value: secret

Allowed Values [secret, sts]. STS type will be used for role assumption for sts type, accessKey/secretKey contains the source account, Arn is the target account.

partitionstring

Possible values: [aws, aws-us-gov]

Default value: aws

AWS accounts are scoped to a single partition. Allowed values [aws, aws-us-gov], Default values

policyARNsstring[]

List of policy ARNs required in case of credentialType sts.

secretKeystring

AWS account secret key

sts

object

AWS STS credentials in case of credentialType sts, will be empty in case of credential type secret

arnstring

Arn for the aws sts credentials in cloud account

externalIdstring

ExternalId for the aws sts credentials in cloud account

Responses

200

(empty)

application/json

Schema

Schema

idstring

AWS image id

namestring

AWS image name

ownerstring

AWS image owner id

Example (from schema)

{
  "id": "string",
  "name": "string",
  "owner": "string"
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L 'https://api.spectrocloud.com/v1/clouds/aws/regions/:region/images' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
-d '{
  "amiName": "string",
  "awsAccount": {
    "accessKey": "string",
    "credentialType": "secret",
    "partition": "aws",
    "policyARNs": [
      "string"
    ],
    "secretKey": "string",
    "sts": {
      "arn": "string",
      "externalId": "string"
    }
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

region — pathrequired

ProjectUid — header

Body

{
  "amiName": "string",
  "awsAccount": {
    "accessKey": "string",
    "credentialType": "secret",
    "partition": "aws",
    "policyARNs": [
      "string"
    ],
    "secretKey": "string",
    "sts": {
      "arn": "string",
      "externalId": "string"
    }
  }
}