Air APIAPI ReferenceManifests

Create a platform information entry

View as Markdown

Platform information entries describe per-platform port maps, minimum resource requirements, and port configuration used to configure hardware platform-specific behavior.

Required scope: air:image_write (roles: air_image_publisher, air_image_uploader)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
modelstringRequired1-128 characters
The platform model to which this information applies.
port_mapmap from strings to maps from strings to objectsRequired
Mapping of speed modes to port label entries.
platform_information_versionstringRequired1-64 characters
Version string for this platform information entry.
ports_configobjectRequired
Port configuration.
os_typestring or nullOptional<=128 characters

OS family identifier (e.g. sonic, nvos). Exactly one of os_type or emulation_type must be set; the other is null.

emulation_typestring or nullOptional<=255 characters

The type of simulation engine to which this information applies. Exactly one of os_type or emulation_type must be set; the other is null.

varsmap from strings to stringsOptional

Free-form key-value variables. Values are stored as text.

simulator_configmap from strings to anyOptional

Free-form simulator configuration dictionary.

minimum_resourcesobject or nullOptional
Minimum resource requirements.

Response

idstringRead-onlyformat: "uuid"
createddatetimeRead-only
modifieddatetimeRead-only
creatorstring or nullRead-only
The username of the user who created this platform information entry.
modelstring<=128 characters
The platform model to which this information applies.
port_mapmap from strings to maps from strings to objects
Mapping of speed modes to port label entries.
platform_information_versionstring<=64 characters
Version string for this platform information entry.
ports_configobject
Port configuration.
os_typestring or nullOptional<=128 characters

OS family identifier (e.g. sonic, nvos). Exactly one of os_type or emulation_type must be set; the other is null.

emulation_typestring or nullOptional<=255 characters

The type of simulation engine to which this information applies. Exactly one of os_type or emulation_type must be set; the other is null.

varsmap from strings to stringsOptional

Free-form key-value variables. Values are stored as text.

simulator_configmap from strings to anyOptional

Free-form simulator configuration dictionary.

minimum_resourcesobject or nullOptional
Minimum resource requirements.

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error