Coverage zone management — define which mobile operators are available for your plans. Coverages group operators by country and compatibility zone.
List coverages
Paginated list of coverages in your organisation.
Filters combine with AND semantics; repeatable filters
(operator_ids, countries, compatibility_zones) match any of
the provided values. search does a case-insensitive substring
match across the coverage name, id, and any included operator
name. Soft-deleted coverages are not returned.
query Parameters
pagePage number (1-based).
Page number (1-based).
page_sizeItems per page.
Items per page.
sort_byField to sort by. Omit for default ordering (most recently updated first).
Field to sort by. Omit for default ordering (most recently updated first).
sort_orderSort direction.
Sort direction.
operator_idsFilter to coverages that include any of these operator ids. Repeatable.
Filter to coverages that include any of these operator ids. Repeatable.
countriesFilter by ISO 3166-1 alpha-3 country codes of included operators. Repeatable. Unknown codes return 422.
Filter by ISO 3166-1 alpha-3 country codes of included operators. Repeatable. Unknown codes return 422.
compatibility_zonesFilter by compatibility zone of included operators. Repeatable.
Filter by compatibility zone of included operators. Repeatable.
searchFree-text match against coverage name, id, or included operator name.
Free-text match against coverage name, id, or included operator name.
List coverages › Responses
Successful Response
Items on the current page.
totalTotal number of items across all pages.
pageCurrent page number (1-based).
page_sizeItems per page used to compute this response.
pagesTotal number of pages at the current page_size.
Create a coverage
Create a coverage from a non-empty set of existing operators.
All operators must belong to the same compatibility-zone family;
mixing zones across providers is rejected with 422. The supplied
name is stored locally and never sent to the provider — the
provider receives a synthesized id.
Create a coverage › Request Body
nameDisplay name for the coverage. Not required to be unique.
operator_idsOperator ids to include in the coverage. Must be non-empty.
Create a coverage › Responses
Coverage created.
idInternal coverage identifier.
nameCoverage display name.
created_atUTC timestamp when the coverage was created.
updated_atUTC timestamp of the last update.
compatibility_zonesCompatibility zones spanned by the operators in this coverage.
Operators included in this coverage.
List operators usable in coverages
Paginated list of operators in your organisation's catalogue.
Operators are the building blocks of coverages — pick a set to
create or extend a coverage. Filters combine with AND semantics;
repeatable filters (countries, compatibility_zones,
network_types) match any of the provided values. search does a
case-insensitive substring match across name, TADIG, and id.
query Parameters
pagePage number (1-based).
Page number (1-based).
page_sizeItems per page.
Items per page.
sort_byField to sort by. Omit for default ordering (most recently updated first).
Field to sort by. Omit for default ordering (most recently updated first).
sort_orderSort direction.
Sort direction.
countriesFilter by ISO 3166-1 alpha-3 country codes. Repeatable. Unknown codes return 422.
Filter by ISO 3166-1 alpha-3 country codes. Repeatable. Unknown codes return 422.
compatibility_zonesFilter by compatibility zone. Repeatable.
Filter by compatibility zone. Repeatable.
network_typesFilter by supported network technology. Repeatable.
Filter by supported network technology. Repeatable.
searchFree-text match against name, TADIG, or id.
Free-text match against name, TADIG, or id.
List operators usable in coverages › Responses
Successful Response
Items on the current page.
totalTotal number of items across all pages.
pageCurrent page number (1-based).
page_sizeItems per page used to compute this response.
pagesTotal number of pages at the current page_size.
Get a coverage
Fetch a single coverage by id within the caller's organisation.
path Parameters
coverage_idGet a coverage › Responses
Successful Response
idInternal coverage identifier.
nameCoverage display name.
created_atUTC timestamp when the coverage was created.
updated_atUTC timestamp of the last update.
compatibility_zonesCompatibility zones spanned by the operators in this coverage.
Operators included in this coverage.
Delete a coverage
Soft-delete a coverage.
The provider's resource is deleted and the coverage is marked
REMOVED locally — subsequent reads return 410. The coverage's
operators are unaffected (they remain in the org's catalogue). A
coverage that is still used by any plan cannot be deleted (422).
Returns 204 No Content — REST-standard for delete. Other
modifying endpoints return the updated entity, but a returned body
here would be identical to a pre-delete GET (we deliberately don't
expose status on the wire), so it would signal nothing the status
code didn't already.
path Parameters
coverage_idDelete a coverage › Responses
Coverage deleted.
Rename a coverage
Rename a coverage.
Local-only change — the provider's synthesized id is unaffected and no provider call is made. Returns the updated coverage.
path Parameters
coverage_idRename a coverage › Request Body
nameNew display name for the coverage. Not required to be unique.
Rename a coverage › Responses
Successful Response
idInternal coverage identifier.
nameCoverage display name.
created_atUTC timestamp when the coverage was created.
updated_atUTC timestamp of the last update.
compatibility_zonesCompatibility zones spanned by the operators in this coverage.
Operators included in this coverage.
Add operators to a coverage
Add operators to an existing coverage.
Idempotent — ids already present in the coverage are silently skipped. All ids must resolve to operators in the same compatibility-zone family as the coverage's existing operators; mixing families across providers is rejected with 422. Returns the updated coverage.
path Parameters
coverage_idAdd operators to a coverage › Request Body
operator_idsOperator ids to add or remove. Must be non-empty.
Add operators to a coverage › Responses
Successful Response
idInternal coverage identifier.
nameCoverage display name.
created_atUTC timestamp when the coverage was created.
updated_atUTC timestamp of the last update.
compatibility_zonesCompatibility zones spanned by the operators in this coverage.
Operators included in this coverage.
Remove operators from a coverage
Remove operators from an existing coverage.
Bulk action endpoint — uses POST with a /remove action segment
rather than DELETE-with-body, which the HTTP spec discourages and
some proxies strip. The operators themselves are not destroyed;
they remain in the org's catalogue and can be added to other
coverages.
Idempotent — ids not currently in the coverage are silently skipped. Removing all operators (leaving the coverage with zero) is rejected with 422. Returns the updated coverage.
path Parameters
coverage_idRemove operators from a coverage › Request Body
operator_idsOperator ids to add or remove. Must be non-empty.
Remove operators from a coverage › Responses
Successful Response
idInternal coverage identifier.
nameCoverage display name.
created_atUTC timestamp when the coverage was created.
updated_atUTC timestamp of the last update.
compatibility_zonesCompatibility zones spanned by the operators in this coverage.
Operators included in this coverage.