Create IP Block

View as Markdown

Create an IP block for the org.

Only Infrastructure Providers can create a root IP Block. User must have FORGE_PROVIDER_ADMIN role.

Tenant IP Blocks are created via Allocation.

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

Request

This endpoint expects an object.
namestringRequired2-256 characters
siteIdstringRequiredformat: "uuid"
routingTypeenumRequired
Allowed values:
prefixstringRequired
Either IPv4 or IPv6 address
prefixLengthintegerRequired

Min: 1, Max: 32 for IPv4, 128 for IPv6

protocolVersionenumRequired
Allowed values:
descriptionstringOptional

Response

Created
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

400
Bad Request Error
403
Forbidden Error