List endpoint groups
/endpoint-groupsLists all available endpoint groups for the authenticated user.
Required scope
group:readQuery parameters
- enablement
string Filter the results by enablement. Enablement is a customer setting that stops Port OS from using a resource without deleting it. Port OS uses it in place of deletion because it cannot delete a device on the provider's side. Defaults to ENABLED. Use DISABLED to list only disabled resources, or '*' to include both enabled and disabled resources. Looking up a resource by its exact id ignores this filter.
Default:
ENABLEDAllowed values: ENABLED, DISABLED, *.
- owner
string Filter the results by the owner of the resource. Defaults to the authenticated caller's resources when omitted. Use '~caller' to make that scope explicit. Another owner can be selected only for resources the caller can read.
- nextToken
string Opaque token for the next page of results. Pass the continuation token returned by the previous response, unchanged. Omit it to start from the first page.
- maxResults
integer Maximum number of results to return in one page. Defaults to 100. Values from 1 through 100 are accepted.
minimum: 1
maximum: 100
Default:
100
Errors
400 BAD_REQUESTBad request - missing required parameters
Check the request fields and any validation details, then correct the payload.
401 UNAUTHORIZEDUnauthorized - invalid or missing authentication token
Obtain a valid access token, then retry.
403 FORBIDDENForbidden - insufficient permissions
Check the linked account and its permissions for the device or resource.
500 INTERNALInternal server error
Retry with backoff only when the operation is safe to repeat. Include the error code when reporting persistent failures.