Get Gateways a user can reference
get
/apiplatform/management/v1/plans/{planId}/references/gateways
Returns all gateways that the {planId}
plan can reference.
Users requesting this resource must be assigned the Plan Manager role and must be issued the Manage Plan grant for the specified plan.
Request
Supported Media Types
- application/json
Path Parameters
-
planId: string
A unique ID referencing a specific plan.
Query Parameters
-
fields(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values. -
limit(optional): integer(int32)
Number of items to retrieve.
1
is the minumum;128
is the maximum.Default Value:128
-
offset(optional): integer(int32)
Offset the list returned results by this amount. Default is zero.Default Value:
0
- orderBy(optional): array
-
q(optional): string
Pass filtering criteria, using the SCIM filter expression syntax
-
totalResults(optional): boolean
Include the total result count in the response.Default Value:
false
Response
Supported Media Types
- application/json
200 Response
The collection of gateways
Nested Schema : CollectionResponseFeature
Type:
Show Source
object
-
count(optional):
integer(int32)
The number of items in this collection.
Nested Schema : CollectionResponsePagingFeature
Type:
Show Source
object
-
totalResults(optional):
integer(int32)
The total number of results available. Only provided if the showTotalResults query parameter is set to true
Nested Schema : GatewayDef
Type:
Show Source
object
-
configuration(optional):
object configuration
-
description(optional):
string
The gateway's description.
-
firewall(optional):
object firewall
-
location(optional):
string
The gateway's location.
-
proxyUrls(optional):
array proxyUrls
-
releaseVersion(optional):
string
The gateway's release version. This property is used only at node registration time to seed the original release version of the node.
-
urls(optional):
array urls
Nested Schema : GatewayMetadata
Type:
Show Source
object
-
createdAt(optional):
string
The date and time the gateway was created.
-
createdBy(optional):
string
The user who created the gateway.
-
updatedAt(optional):
string
The date time the gateway was last updated.
-
updatedBy(optional):
string
The user who last updated the gateway.
403 Response
Forbidden.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
Unexpected error.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type