Networking

Preview — pending review

This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.

List IKE (Phase 1) policies in the active scope

GET
/scopes/{scopeId}/network/vpn/ike-policies

Returns the paginated collection of IKE (Phase 1) policies in the active scope. An IKE policy is a FIRST-CLASS, REUSABLE resource that mirrors the neutron-VPNaaS ikepolicies resource one-for-one: one policy may be referenced by many IPsec site connections, and is never cloned per connection. Each row carries the negotiated algorithm set (auth, encryption, PFS group, IKE version, phase-1 negotiation mode), the security-association lifetime as neutron's own units+value pair, this record's provisioning state and usedByCount - how many site connections currently reference it, which is what makes a delete or an update of an in-use policy fail. Validation: scopeId must resolve to an accessible scope (unknown/forbidden scope -> 403 or 404); region, sort, order, page and pageSize must be well-formed (malformed paging -> 422 VALIDATION_FAILED); caller needs at least the reader role on the scope, otherwise 403 FORBIDDEN. Async & state: Synchronous read; no state change. Errors: 401 when unauthenticated; 403 when the caller lacks read permission on the scope; 422 when query parameters fail validation; 500 on backend read failure. Idempotency/Concurrency: Safe, cacheable; no idempotency key required. Soft-deleted policies are excluded (deleted_at IS NULL).

Authorization

bearerToken
headerAuthorizationBearer <token>

An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.

Path Parameters

scopeId*string

Opaque ownership+authorization scope resolving to tenant + subscription + project.

Query Parameters

region?string

Restrict the result set to a single region.

Match^[a-z][a-z0-9-]{1,39}$
q?string

Free-text search.

sort?string

Field to sort by (entity-specific; defaults to the entity's natural order).

order?string

Sort direction.

Default"asc"
Value in"asc""desc"
page?integer

1-based page number.

Range1 <= value
Default1
pageSize?integer

Items per page (max 200).

Range1 <= value <= 200
Default50

Response Body

Paginated collection of IKE policies in the active scope.

application/json
  1. response
data*array<>
meta*

Pagination envelope metadata. List responses are always { data, meta } — never a naked array.

curl -X GET "https://example.com/scopes/string/network/vpn/ike-policies"
{  "data": [    {      "origin": "portal",      "id": "string",      "name": "string",      "description": "string",      "authAlgorithm": "sha1",      "encryptionAlgorithm": "3des",      "pfs": "group2",      "ikeVersion": "v1",      "phase1NegotiationMode": "main",      "lifetimeUnits": "seconds",      "lifetimeValue": 60,      "provisioningState": "PENDING_CREATE",      "statusReason": "string",      "statusReasonCode": "string",      "providerId": "string",      "usedByCount": 0    }  ],  "meta": {    "page": 1,    "pageSize": 1,    "total": 0,    "hasNext": true  }}