Album API (1.0.0)

Download OpenAPI specification:Download

AMI sharing service

GET

Get current images

Returns a list of current images.

query Parameters
product_type
string (product_type)
Enum: "ids" "scan" "wsm"

Product Type

platform_type
string (platform_type)
Value: "aws"

Platform Type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all images

Returns a list of all image records, including their ami name and description.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get specified image

Returns single image record, including their ami name and description.

path Parameters
image_id
required
string (image_id)
Example: ami-11111111111111111

Responses

Response samples

Content type
application/json
{
  • "image_id": "string",
  • "region": "string"
}

Get specified images' product type

Returns product type for specified image id.

path Parameters
image_id
required
string (image_id)
Example: ami-11111111111111111

Responses

Response samples

Content type
application/json
"ids"

Get a specific version set of images

Get a specific version set of images.

path Parameters
platform_type
required
string (platform_type)
Value: "aws"

platform type

product_type
required
string (product_type)
Enum: "ids" "scan" "wsm"

product type

version
required
string (version)
Example: v1.0.0

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get enabled sets of images

Get enabled sets of images per product type.

Responses

Get all sets of images

Get all sets of images.

Responses

PUT

Add launch permission

Adds launch permission for the current images the the specified platform account.

path Parameters
platform_type
required
string (platform_type)
Value: "aws"

platform type

platform_id
required
string (platform_id)
Example: 0000-0000-0000

Responses

Enable a specific version set of images

Enable a specific version set of images.

path Parameters
platform_type
required
string (platform_type)
Value: "aws"

platform type

product_type
required
string (product_type)
Enum: "ids" "scan" "wsm"

product type

version
required
string (version)
Example: v1.0.0

Responses

POST

Add new images

Add a new version of images.

path Parameters
platform_type
required
string (platform_type)
Value: "aws"

platform type

product_type
required
string (product_type)
Enum: "ids" "scan" "wsm"

product type

version
required
string (version)
Example: v1.0.0
Request Body schema: application/json
ami_name
required
string (ami_name) non-empty

Description for the image

description
required
string (description)

Description for the image

required
Array of objects (image_array) >= 0 items

Responses

Request samples

Content type
application/json

An array of records that will be added to the db, this will also put all ami in the request under a single version.

{
  • "ami_name": "Example-AMI-Name",
  • "description": "Example-AMI-Description",
  • "image_array": [
    ]
}