Get Static IP Rule

Retrieve details of a specific static IP rule, including its current application status on all resources.

Request

GET /static-ip-rules/{id}

Authentication

Requires an Admin Bearer JWT token.

Authorization: Bearer <access_token>

Path Parameters

Parameter	Type	Required	Description
id	UUID	Yes	The unique identifier of the static IP rule

Response

Returns the static IP rule object with resource application status.

Success Response

Status Code: 200 OK

Response Body:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "label": "Office Network",
  "ipAddress": "203.0.113.0/24",
  "status": "ACTIVE",
  "createdByEmail": "[email protected]",
  "createdAt": "2026-01-15T09:00:00Z",
  "resources": [
    {
      "resourceId": "660e8400-e29b-41d4-a716-446655440001",
      "resourceName": "Production DB Security Group",
      "status": "APPLIED",
      "appliedAt": "2026-01-15T09:00:30Z",
      "errorMessage": null
    },
    {
      "resourceId": "770e8400-e29b-41d4-a716-446655440002",
      "resourceName": "API Server Security Group",
      "status": "APPLIED",
      "appliedAt": "2026-01-15T09:00:35Z",
      "errorMessage": null
    }
  ]
}

Response Fields

Field	Type	Description
id	UUID	Unique identifier for the static IP rule
label	string	Human-readable label for the rule
ipAddress	string	IP address or CIDR range (IPv4 or IPv6)
status	string	Overall status: ACTIVE, PENDING, PARTIAL, or FAILED
createdByEmail	string	Email of the user who created the rule
createdAt	string	ISO timestamp of creation
resources	array	List of resources where this rule is applied
resources[].resourceId	UUID	Resource unique identifier
resources[].resourceName	string	Human-readable resource name
resources[].status	string	Application status: APPLIED, PENDING, or FAILED
resources[].appliedAt	string	ISO timestamp when rule was applied (null if pending/failed)
resources[].errorMessage	string	Error description if status is FAILED

Rule Status Values

Status	Description
ACTIVE	Rule is successfully applied to all resources
PENDING	Rule is being applied asynchronously
PARTIAL	Rule is applied to some resources but failed on others
FAILED	Rule failed to apply to all resources

Errors

Status Code	Error Code	Description
401	UNAUTHORIZED	Missing or invalid JWT token
403	FORBIDDEN	User does not have admin privileges
404	NOT_FOUND	Static IP rule with the specified ID does not exist or does not belong to your organization

Example

Request

curl -X GET https://api.entryguard.io/api/v1/static-ip-rules/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "label": "Office Network",
  "ipAddress": "203.0.113.0/24",
  "status": "ACTIVE",
  "createdByEmail": "[email protected]",
  "createdAt": "2026-01-15T09:00:00Z",
  "resources": [
    {
      "resourceId": "660e8400-e29b-41d4-a716-446655440001",
      "resourceName": "Production DB Security Group",
      "status": "APPLIED",
      "appliedAt": "2026-01-15T09:00:30Z",
      "errorMessage": null
    },
    {
      "resourceId": "770e8400-e29b-41d4-a716-446655440002",
      "resourceName": "API Server Security Group",
      "status": "APPLIED",
      "appliedAt": "2026-01-15T09:00:35Z",
      "errorMessage": null
    }
  ]
}

Notes

• Use this endpoint to poll the status of a newly created static IP rule to determine when it has been successfully applied to all resources.
• If the status is PARTIAL or FAILED, check the errorMessage field on each resource to diagnose the issue.