Service Catalog
Service catalog and endpoint management operations
Lists services
Authentication token obtained from the authentication service
Filter by service type
Filter by service name
Requests a page size of items
The ID of the last-seen item for pagination
A valid authentication token
Services listed successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
GET /v3/services HTTP/1.1
Host: identity.example.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"
}
}Creates a service
Authentication token obtained from the authentication service
A valid authentication token
Service created successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
This operation conflicted with another operation on this resource
POST /v3/services HTTP/1.1
Host: identity.example.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"
}
}
}Shows details for a service
Authentication token obtained from the authentication service
The service ID
A valid authentication token
Service details retrieved successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
GET /v3/services/{service_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
{
"service": {
"id": "text",
"name": "text",
"type": "text",
"description": "text",
"enabled": true,
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
}Deletes a service
Authentication token obtained from the authentication service
The service ID
A valid authentication token
Service deleted successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
DELETE /v3/services/{service_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
No content
Updates a service
Authentication token obtained from the authentication service
The service ID
A valid authentication token
Service updated successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
This operation conflicted with another operation on this resource
PATCH /v3/services/{service_id} HTTP/1.1
Host: identity.example.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"
}
}
}Lists endpoints
Authentication token obtained from the authentication service
Filter by interface type
Filter by service ID
Filter by region ID
Filter by enabled status
Requests a page size of items
The ID of the last-seen item for pagination
A valid authentication token
Endpoints listed successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
GET /v3/endpoints HTTP/1.1
Host: identity.example.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"
}
}Creates an endpoint
Authentication token obtained from the authentication service
A valid authentication token
Endpoint created successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
This operation conflicted with another operation on this resource
POST /v3/endpoints HTTP/1.1
Host: identity.example.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"
}
}
}Shows details for an endpoint
Authentication token obtained from the authentication service
The endpoint ID
A valid authentication token
Endpoint details retrieved successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
GET /v3/endpoints/{endpoint_id} HTTP/1.1
Host: identity.example.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"
}
}
}Deletes an endpoint
Authentication token obtained from the authentication service
The endpoint ID
A valid authentication token
Endpoint deleted successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
DELETE /v3/endpoints/{endpoint_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
No content
Updates an endpoint
Authentication token obtained from the authentication service
The endpoint ID
A valid authentication token
Endpoint updated successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
This operation conflicted with another operation on this resource
PATCH /v3/endpoints/{endpoint_id} HTTP/1.1
Host: identity.example.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"
}
}
}Last updated
Was this helpful?