Create Isolation Segment

Create an isolation segment

Create an isolation segment.

Request

URI

POST

https://api.example.local/v3/isolation_segments

COPY

Request Body

Isolation segment to create

IsolationSegmentCreate of type(s) application/json

Optional

Show optional properties

{
    "name": "string"
}

{
    "name": "string",
    "metadata": {
        "labels": {
            "labels": "string"
        },
        "annotations": {
            "annotations": "string"
        }
    }
}

Authentication

This operation uses the following authentication methods.

oauth

bearer

Responses

201

Created

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"
        }
    }
}

400

Bad Request

Returns BadRequest of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

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

409

Conflict

Returns Conflict of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

422

Unprocessable Entity

Returns UnprocessableEntity of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

500

Internal Server Error

Returns 500 of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

503

Service Unavailable

Returns ServiceUnavailable of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name":"string"}' https://{api_host}/v3/isolation_segments

On This Page

Description

Request

Request Body

Authentication

Response

201 Response Body

Errors

Isolation Segments Operations

GET

List Isolation Segments

POST