Service Catalog

Service catalog and endpoint management operations

List services

get

Lists services

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Query parameters

typestringOptional

Filter by service type

namestringOptional

Filter by service name

limitinteger · min: 1Optional

Requests a page size of items

markerstringOptional

The ID of the last-seen item for pagination

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

200

Services listed successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

get

/services

HTTPcURLJavaScriptPython

GET /keystone/v3/services HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

{
  "services": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "description": "text",
      "enabled": true,
      "links": {
        "self": "text",
        "previous": "text",
        "next": "text"
      }
    }
  ],
  "links": {
    "self": "text",
    "previous": "text",
    "next": "text"
  }
}

Create service

post

Creates a service

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Body

application/json

Responses

201

Service created successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

409

This operation conflicted with another operation on this resource

application/json

post

/services

HTTPcURLJavaScriptPython

POST /keystone/v3/services HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "service": {
    "name": "text",
    "type": "text",
    "description": "text",
    "enabled": true
  }
}

{
  "service": {
    "id": "text",
    "name": "text",
    "type": "text",
    "description": "text",
    "enabled": true,
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

Show service details

get

Shows details for a service

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

service_idstringRequired

The service ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

200

Service details retrieved successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

get

/services/{service_id}

HTTPcURLJavaScriptPython

GET /keystone/v3/services/{service_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

{
  "service": {
    "id": "text",
    "name": "text",
    "type": "text",
    "description": "text",
    "enabled": true,
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

Delete service

delete

Deletes a service

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

service_idstringRequired

The service ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

204

Service deleted successfully

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

delete

/services/{service_id}

HTTPcURLJavaScriptPython

DELETE /keystone/v3/services/{service_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

No content

Update service

patch

Updates a service

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

service_idstringRequired

The service ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Body

application/json

Responses

200

Service updated successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

409

This operation conflicted with another operation on this resource

application/json

patch

/services/{service_id}

HTTPcURLJavaScriptPython

PATCH /keystone/v3/services/{service_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "service": {
    "name": "text",
    "type": "text",
    "description": "text",
    "enabled": true
  }
}

{
  "service": {
    "id": "text",
    "name": "text",
    "type": "text",
    "description": "text",
    "enabled": true,
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

List endpoints

get

Lists endpoints

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Query parameters

interfacestring · enumOptional

Filter by interface type

Possible values:

service_idstringOptional

Filter by service ID

region_idstringOptional

Filter by region ID

enabledbooleanOptional

Filter by enabled status

limitinteger · min: 1Optional

Requests a page size of items

markerstringOptional

The ID of the last-seen item for pagination

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

200

Endpoints listed successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

get

/endpoints

HTTPcURLJavaScriptPython

GET /keystone/v3/endpoints HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

{
  "endpoints": [
    {
      "id": "text",
      "service_id": "text",
      "interface": "public",
      "url": "text",
      "region_id": "text",
      "enabled": true,
      "links": {
        "self": "text",
        "previous": "text",
        "next": "text"
      }
    }
  ],
  "links": {
    "self": "text",
    "previous": "text",
    "next": "text"
  }
}

Create endpoint

post

Creates an endpoint

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Body

application/json

Responses

201

Endpoint created successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

409

This operation conflicted with another operation on this resource

application/json

post

/endpoints

HTTPcURLJavaScriptPython

POST /keystone/v3/endpoints HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "endpoint": {
    "service_id": "text",
    "interface": "public",
    "url": "text",
    "region_id": "text",
    "enabled": true
  }
}

{
  "endpoint": {
    "id": "text",
    "service_id": "text",
    "interface": "public",
    "url": "text",
    "region_id": "text",
    "enabled": true,
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

Show endpoint details

get

Shows details for an endpoint

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

endpoint_idstringRequired

The endpoint ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

200

Endpoint details retrieved successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

get

/endpoints/{endpoint_id}

HTTPcURLJavaScriptPython

GET /keystone/v3/endpoints/{endpoint_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

{
  "endpoint": {
    "id": "text",
    "service_id": "text",
    "interface": "public",
    "url": "text",
    "region_id": "text",
    "enabled": true,
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

Delete endpoint

delete

Deletes an endpoint

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

endpoint_idstringRequired

The endpoint ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

204

Endpoint deleted successfully

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

delete

/endpoints/{endpoint_id}

HTTPcURLJavaScriptPython

DELETE /keystone/v3/endpoints/{endpoint_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

No content

Update endpoint

patch

Updates an endpoint

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

endpoint_idstringRequired

The endpoint ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Body

application/json

Responses

200

Endpoint updated successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

409

This operation conflicted with another operation on this resource

application/json

patch

/endpoints/{endpoint_id}

HTTPcURLJavaScriptPython

PATCH /keystone/v3/endpoints/{endpoint_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "endpoint": {
    "service_id": "text",
    "interface": "public",
    "url": "text",
    "region_id": "text",
    "enabled": true
  }
}

{
  "endpoint": {
    "id": "text",
    "service_id": "text",
    "interface": "public",
    "url": "text",
    "region_id": "text",
    "enabled": true,
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}