REST API for the Management Service in Oracle API Platform Cloud Service

Update API identity

put

/apiplatform/management/v1/apis/{apiId}/identity

Changes the name, version, or vanityName of the {apiId} API.

Users requesting this resource must be assigned the API Manager role and must be issued the Manage API grant for the specified API.

Request

Supported Media Types

application/json

Path Parameters

apiId: string

A unique ID referencing a specific API.

Root Schema : UpdateApiIdentityRequest

Type: object

Show Source

name(optional): string

The updated API name. API names can include only letters, digits, spaces, underscores, hyphens, and periods.
vanityName(optional): string

The updated API vanity name. API vanity names can include only letters, digits, spaces, underscores, hyphens, and periods.
version(optional): string

The updated API version. API versions can include only letters, digits, spaces, underscores, hyphens, and periods.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The updated API name. API names can include only letters, digits, spaces, underscores, hyphens, and periods."
        },
        "version":{
            "type":"string",
            "description":"The updated API version. API versions can include only letters, digits, spaces, underscores, hyphens, and periods."
        },
        "vanityName":{
            "type":"string",
            "description":"The updated API vanity name. API vanity names can include only letters, digits, spaces, underscores, hyphens, and periods."
        }
    }
}

Response

Supported Media Types

application/json

204 Response

The API's identity was updated.

400 Response

Bad request, indicates a problem with the input parameters.

Root Schema : Error

Type: object

Show Source

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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

403 Response

Forbidden.

Root Schema : Error

Type: object

Show Source

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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Root Schema : Error

Type: object

Show Source

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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Examples

The following example shows how to change the name, version, or description of the API by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X PUT 
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/apis/{apiId}/identity

{apiId} is the unique Id for an API. To retrieve available API Ids, see Get APIs.

Example of Request Body

The following example provides a request body for updating an API. You can update the following attributes.

Name (optional): The name of the API.
Version (optional): The version of the API.
vanityName (optional): The vanityname of the API.

{
"name":Climate,
"version":"v2",
"vanityName":"Climate2"
}

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Server: Oracle-Traffic-Director/12.2.1.0.0
Date:  Mon, 13 Mar 2017 09:51:17 GMT
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-000196fb
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0