Update a Fleet

put

https://api.edgeiq.io/api/v1/platform/fleets/{id}

Update an existing fleet. Note that changing 'fleet_type' between static and dynamic is not allowed after creation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID that specifies a Fleet

Body Params

company_id

string

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

fleet_unique_id

string

length ≤ 255

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

fleet_name

string

required

length ≤ 255

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

fleet_type

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:

description

string

length ≤ 2000

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

notes

string

length ≤ 5000

Additional notes about the fleet. Maximum 5000 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

403

You are forbidden from accessing this resource

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Fleet updated successfully