endpoint

Update an endpoint

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

Endpoint + Update <span className="permission-callout__also">+1 endpoint</span>

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge></div> </Info>

Updates the details of an endpoint.

<Note> Execute this operation sequentially - wait for each request to complete before starting the next.

For bulk updates, use PATCH /api/v2/endpoint/multi instead (supports up to 2,000 endpoints). </Note>

<Warning> emnify charges for activated SIMs, even if the endpoint `status` is set to **Disabled**. To avoid accruing unexpected charges, update the SIM `status` to **Suspended** (`"id": 2`). </Warning>
patch/api/v1/endpoint/{endpoint_id}

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/endpoint/{endpoint_id}
  • Auth: HTTP bearer

Path parameters

endpoint_idinteger required

Numeric ID of an endpoint

Request body

namestring required
tagsstring nullable

Comma-separated tag names replacing the tags currently assigned to the endpoint. Tags that don't exist yet are created, an empty string removes all tags. Sending null leaves the current tags unchanged, the same as omitting the field.

<Warning> Deprecated. Use `tag_assignments` instead. </Warning>
tag_assignmentsinteger[]

IDs of existing tags replacing the tags currently assigned to the endpoint. An empty array removes all tags.

<Info> Mutually exclusive with `tags`. Provide at most one of the two. </Info>
imeistring required
imei_lockboolean required
ip_addressstring required

Response

Endpoint updated successfully

object required

Changes

No recorded changes to this operation across all 1 revision of this API.