List Service Segments

Paginated list of all Service Segments

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/segments/service-segments

Request Headers:

n/a

Query Parameters:

ServiceSegmentListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/segments/service-segments

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ServiceSegmentListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Service Segment list results	array of ServiceSegment	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "results": [ { "transport_zone_path": "/infra/sites/default/enforcement-points/default/transport-zones/be553b11-040b-4a51-870d-c32fced0ba7d", "resource_type": "ServiceSegment", "id": "service-segment-1", "display_name": "service-segment-1", "path": "/infra/segments/service-segments/service-segment-1", "relative_path": "service-segment-1", "parent_path": "/infra/segments/service-segments/service-segment-1", "marked_for_delete": false, "_create_user": "admin", "_create_time": 1543227416946, "_last_modified_user": "admin", "_last_modified_time": 1543227416946, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } ], "result_count": 1, "sort_by": "display_name", "sort_ascending": true }

List Service Segments

Request:

ServiceSegmentListRequestParameters (schema)

Example Request:

Successful Response:

ServiceSegmentListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: