API ReferenceIP Block

Retrieve all IP Blocks

View as Markdown

Retrieve all IP blocks for the org.

User must have FORGE_PROVIDER_ADMIN or FORGE_TENANT_ADMIN role. infrastructureProviderId or tenantId query param may be required for older API versions.

Authentication

AuthorizationBearer
``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

Query parameters

infrastructureProviderIdstringOptionalformat: "uuid"
Filter IP Blocks by Infrastructure Provider ID
tenantIdstringOptionalformat: "uuid"
Filter IP Blocks by Tenant ID
siteIdstringOptionalformat: "uuid"
Filter IP Blocks by Site ID
statusstringOptional
Filter IP Blocks by Status
includeUsageStatsbooleanOptional
Include IP Block usage stats in response
querystringOptional
Search for matches across all Sites. Input will be matched against name, description and status fields
includeRelationenumOptional
Related entity to expand
Allowed values:
pageNumberintegerOptional>=1Defaults to 1
Page number for pagination query
pageSizeintegerOptional1-100
Page size for pagination query
orderByenumOptional
Ordering for pagination query

Response headers

X-Paginationstring
Pagination result in JSON format

Response

OK
idstringRead-onlyformat: "uuid"
namestring2-256 characters
descriptionstring
siteIdstringformat: "uuid"
infrastructureProviderIdstringformat: "uuid"
tenantIdstring or nullformat: "uuid"
routingTypeenum
Allowed values:
prefixstring
Either IPv4 or IPv6 address
prefixLengthinteger

Min: 1, Max: 32 for ipv4, 128 for ipv6

protocolVersionenum
Allowed values:
usageStatsobject
Usa statistics for an IP Block
statusenum
Status values for IP Block objects
Allowed values:
statusHistorylist of objects
deprecationslist of objects
createddatetimeRead-only
updateddatetimeRead-only

Errors

403
Forbidden Error