API ReferenceSubnet

Retrieve all Subnets

View as Markdown

Retrieve all Subnets for the org

Org must have a Tenant entity. User must have FORGE_TENANT_ADMIN role.

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

siteIdstringOptionalformat: "uuid"
Filter subnets by Site, required if vpcId query param is not specified
vpcIdstringOptionalformat: "uuid"
Filter subnets by VPC
statusstringOptional
Filter Subnets by Status
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"
vpcIdstringformat: "uuid"
tenantIdstringformat: "uuid"
controllerNetworkSegmentIdstring or nullformat: "uuid"
ipv4Prefixstring or nullformat: "ipv4"
The prefix that gets assigned to the subnet if ipv4 block is chosen
ipv4BlockIdstring or nullformat: "uuid"
ipv4Gatewaystring or nullformat: "ipv4"
ipv6Prefixstring or nullformat: "ipv6"
ipv6BlockIdstring or nullformat: "uuid"
ipv6Gatewaystring or nullformat: "ipv6"
mtuintegerRead-only

Maximum Transmission Unit size in bytes. This property is system-determined and read-only.

prefixLengthinteger
Max value depends on prefix length of parent IP Block
routingTypeenum
Allowed values:
statusenum
Status values for Subnet objects
Allowed values:
statusHistorylist of objectsRead-only
createddatetimeRead-only
updateddatetimeRead-only
deprecationslist of objects

Errors

403
Forbidden Error