GET OS based on SW_VERSION.

POST

/api/maurice/software_os_version

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/maurice/software_os_version \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "uids": [ "example" ] }'

• F5 Distributed Cloud Console

API to GET OS IMAGE based on the software version.

Examples of this operation.

Authorizations

• ApiToken

Request Body^required

Media typeapplication/json

GetImageOsRequest

Request containing the sw_version.

object

uids

required

Observed Site object UIDs from the system Site collection. For SMSv2 select owner_view.kind equal to securemesh_site_v2 and join owner_view.uid to the exact Secure Mesh Site v2 configuration UID. These are not software-version IDs or configuration-object UIDs. Never fabricate an identifier or infer it from the site name.

Array<string>

>= 1 items <= 100 items unique items

Example^generated

{
  "uids": [
    "example"
  ]
}

Responses

200

A successful response.

Media typeapplication/json

GetImageOsResponse

Response containing the OS image mapping data for the requested software versions Response type: maps a unique identifier (UID) to image information.

object

images

required

Mapping keyed by each requested Site UID. Reject missing mappings, nonempty error_description, or incomplete image fields before use.

object

key

additional properties

object

download_image_link

Download location for the image selected for this Site.

string format: uri

copy_image_name

Provider-specific image name or download location.

string

image_md5_sum

MD5 digest used by the console to verify the image artifact.

string

/^[0-9a-fA-F]{32}$/

error_description

Per-Site lookup failure; any nonempty value rejects the result.

string

Example^generated

{
  "images": {
    "additionalProperty": {
      "download_image_link": "https://example.com",
      "copy_image_name": "example",
      "image_md5_sum": "example",
      "error_description": "example"
    }
  }
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example