Skip to navigation
eMSPNetworks

Add an access rule

INCLUDE shows only the listed locations, EXCLUDE hides them, optionally within an effective_from/effective_until window.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

network_idintegerRequired>=1

The network’s network_id.

Headers

Idempotency-KeystringRequired1-255 characters
A unique key you choose for this call, e.g. a UUID. Retrying with the same key returns the first result instead of acting twice.

Request

This endpoint expects an object.
rule_typeenumRequired
Allowed values:
location_idslist of stringsRequired
priorityinteger or nullOptional-2147483648-2147483647Defaults to 0
effective_fromdatetime or nullOptional
effective_untildatetime or nullOptional

Response

The created rule.
rule_idinteger
network_idinteger
rule_typeenum or any
location_idslist of strings
priorityinteger
created_atdatetime
updated_atdatetime
effective_fromdatetime or nullOptional
effective_untildatetime or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error