Retrieve all Network Security Groups | NVIDIA Infra Controller

curl https://carbide-rest-api.carbide.svc.cluster.local/v2/org/org/carbide/network-security-group \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

[
  {
    "id": "3f9a1b2e-7c4d-4e2a-9f3b-1a2b3c4d5e6f",
    "name": "Corporate Data Center Firewall",
    "description": "Firewall rules for corporate data center instances",
    "siteId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "tenantId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "Provisioning",
    "statusHistory": [
      {
        "status": "Pending",
        "message": "Request received, pending processing",
        "created": "2024-01-15T09:30:00Z",
        "updated": "2024-01-15T09:30:00Z"
      }
    ],
    "statefulEgress": true,
    "rules": [
      {
        "direction": "INGRESS",
        "protocol": "TCP",
        "action": "PERMIT",
        "sourcePrefix": "10.0.0.0/16",
        "destinationPrefix": "10.0.1.0/24",
        "name": "allow-http-from-internal",
        "sourcePortRange": "80-81",
        "destinationPortRange": "80-81",
        "priority": 10
      }
    ],
    "labels": {
      "environment": "production",
      "department": "IT Security"
    },
    "created": "2024-01-15T09:30:00Z",
    "updated": "2024-01-15T09:30:00Z"
  }
]

Get all Network Security Groups for Tenant

Org must have a Tenant entity. User must have FORGE_TENANT_ADMIN authorization 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

``` 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 By Site ID

statusstringOptional

Filter Network Security Groups 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

includeAttachmentStatsbooleanOptional

Include counts for the number objects that have attached the Network Security Group

Response headers

Response

idstring

namestring2-256 characters

descriptionstring

siteIdstringformat: "uuid"

tenantIdstringformat: "uuid"

statusenum

Status values for Network Security Group objects

Allowed values:

statusHistorylist of objects

statefulEgressboolean

ruleslist of objects

labelsmap from strings to strings

createddatetime

updateddatetime

Errors

400

Bad Request Error

403

Forbidden Error

412

Precondition Failed Error

500

Internal Server Error

501

Not Implemented Error