List service configs

List of all service configs.

Request:

Method:

GET

URI Path(s):

/api/v1/service-configs

Request Headers:

n/a

Query Parameters:

ServiceConfigListRequestParameters+

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"
profile_type	Fetch ServiceConfig for the given attribute profile_type It fetches ServiceConfig for the given profile_type. Only one type of supported profile type can be mentioned in a single API call. API will return all ServiceConfig if this field is not passed.	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/service-configs

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ServiceConfigListResult+

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 config list results	array of ServiceConfig	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:

{ "sort_ascending": true, "sort_by": "display_name", "result_count": 2, "results": [ { "_revision": 1, "id": "183e372b-854c-4fcc-a24e-05721ce89a60", "display_name":"testServiceConfig1", "resource_type": "ServiceConfig", "profiles":[{"profile_type":"FirewallSessionTimerProfile", "target_id":"183e372b-854c-4fcc-a24e-05721ce89a45", "is_valid":true }], “precedence”: 10, “applied_to”: [{"target_id":"333e372b-854c-4fcc-a24e-05721ce89b71", "target_type": "NSGroup", "is_valid":true }] "_create_user": "system", "_last_modified_user": "system", "_last_modified_time": 1414057732203, "_create_time": 1414057732203 }, { "_revision": 1, "id": "333e372b-854c-4fcc-a24e-05721ce89b71", "display_name":"testServiceConfig2", "resource_type": "ServiceConfig", "profiles":[{"profile_type":"DFWCPUProfile", target_id":"183e372b-854c-4fcc-a24e-05721ce89a45", "is_valid":true }], “precedence”: 10, “applied_to”: [{"target_id":"333e372b-854c-4fcc-a24e-05721ce89b71", "target_type": "NSGroup", "is_valid":false } ] "_create_user": "system", "_last_modified_user": "system", "_last_modified_time": 1430382085537, "_create_time": 1430382085537 } ] }

List service configs

Request:

ServiceConfigListRequestParameters (schema)

Example Request:

Successful Response:

ServiceConfigListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: