API Reference
Start typing to search…

Create a Fleet

post
https://api.edgeiq.io/api/v1/platform/fleets

Create a new fleet. Specify 'fleet_type' as 'static' for manually managed device membership, or 'dynamic' for automatic membership based on 'filter_criteria'.

Body Params
string

The company account ID for this fleet. If left blank, defaults to the current user's company ID on creation.

string
length ≤ 255

An optional unique identifier for the fleet. Must be unique within the company. Maximum 255 characters.

string
required
length ≤ 255

A descriptive name for this fleet. Required field. Maximum 255 characters.

string
enum
Defaults to static

The type of fleet. 'static' fleets have manually assigned devices. 'dynamic' fleets automatically include devices matching the filter criteria.

Allowed:
string
length ≤ 2000

A detailed description of the fleet's purpose. Maximum 2000 characters.

string
length ≤ 5000

Additional notes about the fleet. Maximum 5000 characters.

tags
array of strings
length ≤ 50

An array of tags for categorizing and organizing fleets. Maximum 50 tags, each tag maximum 100 characters.

tags
filter_criteria
array of objects

Filter criteria for dynamic fleets. Defines which devices automatically belong to the fleet based on device attributes. Required for dynamic fleets, not allowed for static fleets.

filter_criteria
metadata
object

A key/value object for storing custom user-defined data. Maximum 50 keys, key maximum 100 characters, value maximum 1000 characters.

Responses

400

The request was malformed or contained invalid parameters.

401

You are not authorized

500

An unexpected error was encountered.

Updated about 1 month ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago