System - Register Device (BETA)

Required roles: system-c

Register a device on a connection, on a catalog product or, given only a device_type, on no catalog
product, optionally labelled with a name. A device that already has the serial is linked instead, keeping
its own visibility and name; is_visible and name only apply to a new one. Linking it moves it off any
other connection of the same organization, named in previous_connection. A retired device, one of another
organization, or one on another product than the given product is refused. The serial_number may be left
out when it is not known, except for an ONT; such a device is always registered as a new one.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Exactly one of product, a catalog product whose category gives the type, or device_type, for a unit
no catalog product describes.

connection
object
required
product
object
string
enum

A str enum because SimDetailsES.type is a Literal on it: a stored document carries the
plain string, and Literal[PlainEnum.sim] will not validate one.

Allowed:
string | null
boolean
required
string | null
Headers
string
enum

Language of translated texts in the response. Without it, your user's language is used.

Allowed:
uuid

Limit the request to one of the organizations your user has access to. Without it, the request covers all of them.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json