Update Endpoint

put

https://example.com/test/api/web/custom-endpoints/{EndpointId}

api/web/custom-endpoints/{EndpointId}

Updates an existing custom endpoint based on the supplied model and the Endpoint Id.
If endpoint kind is updated follow the below rule.
For endpoint kinds "Function", "Import", and "Snapshot", a valid DatasetId is required.
For the "Table" endpoint kind, a valid SourceId (Table Id) is required.

Path Params

EndpointId

int32

required

≥ 1

The endpoint database ID.

Body Params

The endpoint model with updated values.

Model describing the configuration of a custom API endpoint.

Comment

string | null

The user-provided comment.

Name

string | null

The name of the endpoint. This is a unique string that can be used
to identify the endpoint.

IsPublished

boolean

A value indicating whether the endpointe is published to
OmniFi Access. If set to False, the endpoint is invisible
in the API.

McpVisible

boolean

A value indicating whether the endpoint is visible to MCP clients.

CacheValidTime

string | null

^\s*((?<days>\d{1,4})d)?\s*((?<hours>\d{1,2})h)?\s*((?<minutes>\d{1,2})m)?\s*((?<seconds>\d{1,2})s)?\s*$

The default time period the data from this endpoint is valid after
retrieval from the source system.
The timespan is representad as a string on the form ###d##h##m, where
d = days, h = hours, m = minutes. If the value is null the endpoint has
no default value, and should be interpreted as infinite.

Kind

string

enum

Allowed:

SourceId

int32

The ID of the source table for Table kind endpoints.
For non-Table endpoints this value is 0.

ParentGroupId

int32 | null

The ID of the endpoints parent group within the web portals group structure.

DatasetId

int32

The database ID of the related dataset.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

Language

Loading…

Response

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

application/json

200OK