Get Isolation Segment
Get an isolation segment
Retrieve an isolation segment to which the user has access. For admin, this is any isolation segment in the system. For anyone else, this is an isolation segment in the allowed list for any organization to which the user belongs.
Request
URI
GET
https://api.example.local/v3/isolation_segments/{guid}
COPY
Path Parameters
string
guid
Required
The unique identifier for the resource
Responses
200
OK
Returns
IsolationSegment
of type(s)
application/json
This response body class contains all of the following:
BaseSchema
{
"guid": "string",
"created_at": "string",
"updated_at": "string",
"name": "string",
"metadata": {
"labels": {
"labels": "string"
},
"annotations": {
"annotations": "string"
}
},
"links": {
"self": {
"href": "string",
"method": "string"
},
"organizations": {
"href": "string",
"method": "string"
}
}
}
401
Unauthorized
Returns
Unauthorized
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
403
Forbidden
Returns
Forbidden
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
404
Not Found
Returns
NotFound
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/v3/isolation_segments/{guid}
Isolation Segments Operations
GET
List Isolation Segments
POST
Create Isolation Segment
GET
Get Isolation Segment
PATCH
Update Isolation Segment
DELETE
Delete Isolation Segment
POST
Entitle Organizations For Isolation Segment
GET
List Organizations For Isolation Segment
DELETE
Revoke Isolation Segment For Organization
GET
List Spaces For Isolation Segment