APIsApi


Delete API

Delete an existing API\n

URL

https://apis.wso2.com/api/am/publisher/v0.9/apis/{apiId}

HTTP Method

DELETE

Scope

apim:api_create

CURL Example

curl -H "Authorization: Bearer b0982cd2aacd463ff5f63cd5ebe58f4a" -X DELETE http://127.0.0.1:9763/api/am/publisher/v0.9/apis/6fb74674-4ab8-4b52-9886-f9a376985060

Sample Response

HTTP/1.1 200 OK

Parameters

Type Name Description Schema Default
Path

apiId

required

**API ID** consisting of the **UUID** of the API.\nThe combination of the provider of the API, name of the API and the version is also accepted as a valid API ID.\nShould be formatted as **provider-name-version**.\n

String

Header

If-Match

optional

Validator for conditional requests; based on ETag.\n

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on Last Modified header.\n

String

Responses

HTTP Code Description Schema

200

OK.\nResource successfully deleted.\n

403

Forbidden.\nThe request must be conditional but no condition has been specified.\n

Error

404

Not Found.\nResource to be deleted does not exist.\n

Error

412

Precondition Failed.\nThe request has not been performed because one of the preconditions is not met.\n

Error

Get API details

Get details of an API\n

URL

https://apis.wso2.com/api/am/publisher/v0.9/apis/{apiId}

HTTP Method

GET

Scope

apim:api_view

CURL Example

curl -H "Authorization: Bearer b0982cd2aacd463ff5f63cd5ebe58f4a" http://127.0.0.1:9763/api/am/publisher/v0.9/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b

Sample Response

HTTP/1.1 200 OK Date: Mon, 22 Feb 2016 13:27:08 GMT Content-Type: application/json Transfer-Encoding: chunked Server: WSO2 Carbon Server { "sequences": [], "tiers": [ "Bronze", "Gold" ], "thumbnailUrl": null, "visibility": "PUBLIC", "visibleRoles": [], "visibleTenants": [], "cacheTimeout": 300, "endpointConfig": "{\"production_endpoints\":{\"url\":\" http://ws.cdyne.com/phoneverify/phoneverify.asmx\",\"config\":null},\"endpoint_type\":\"http\"}", "subscriptionAvailability": null, "subscriptionAvailableTenants": [], "destinationStatsEnabled": "Disabled", "apiDefinition": "{\"paths\":{\"\/*\":{\"get\":{\"x-auth-type\":\"Application\",\"x-throttling-tier\":\"Unlimited\",\"responses\":{\"200\":{\"description\":\"OK\"}}}}},\"x-wso2-security\":{\"apim\":{\"x-wso2-scopes\":[]}},\"swagger\":\"2.0\",\"info\":{\"title\":\"PhoneVerification\",\"description\":\"Verify a phone number\",\"contact\":{\"email\":\"xx@ee.com\",\"name\":\"xx\"},\"version\":\"1.0.0\"}}", "responseCaching": "Disabled", "isDefaultVersion": false, "gatewayEnvironments": "Production and Sandbox", "businessInformation": { "technicalOwner": "xx", "technicalOwnerEmail": "ggg@ww.com", "businessOwner": "xx", "businessOwnerEmail": "xx@ee.com" }, "transport": [ "http", "https" ], "tags": [ "phone", "multimedia", "mobile" ], "provider": "admin", "version": "1.0.0", "description": "Verify a phone number", "name": "PhoneVerification", "context": "/phoneverify", "id": "890a4f4d-09eb-4877-a323-57f6ce2ed79b", "status": "PUBLISHED" }

Parameters

Type Name Description Schema Default
Path

apiId

required

**API ID** consisting of the **UUID** of the API.\nThe combination of the provider of the API, name of the API and the version is also accepted as a valid API ID.\nShould be formatted as **provider-name-version**.\n

String

Header

Accept

optional

Media types acceptable for the response. Default is JSON.\n

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved\nvariant of the resourec.\n

String

Header

If-Modified-Since

optional

Validator for conditional requests; based on Last Modified header of the\nformerly retrieved variant of the resource.\n

String

Responses

HTTP Code Description Schema

200

OK.\nRequested API is returned\n

API

304

Not Modified.\nEmpty body because the client has already the latest version of the requested resource.\n

404

Not Found.\nRequested API does not exist.\n

Error

406

Not Acceptable.\nThe requested media type is not supported\n

Error

Update an existing API

Update an existing API\n

URL

https://apis.wso2.com/api/am/publisher/v0.9/apis/{apiId}

HTTP Method

PUT

Scope

apim:api_create

CURL Example

curl -H "Authorization: Bearer b0982cd2aacd463ff5f63cd5ebe58f4a" -H "Content-Type: application/json" -X PUT -d @data.json http://127.0.0.1:9763/api/am/publisher/v0.9/apis/6fb74674-4ab8-4b52-9886-f9a376985060

Sample Request

{ "sequences": [], "tiers": [ "Bronze", "Gold" ], "thumbnailUrl": null, "visibility": "PUBLIC", "visibleRoles": [], "visibleTenants": [], "cacheTimeout": 300, "endpointConfig": "{\"production_endpoints\":{\"url\":\" http://ws.cdyne.com/phoneverify/phoneverify.asmx\",\"config\":null},\"endpoint_type\":\"http\"}", "subscriptionAvailability": null, "subscriptionAvailableTenants": [], "destinationStatsEnabled": "Disabled", "apiDefinition": "{\"paths\":{\"\/*\":{\"get\":{\"x-auth-type\":\"Application\",\"x-throttling-tier\":\"Unlimited\",\"responses\":{\"200\":{\"description\":\"OK\"}}}}},\"x-wso2-security\":{\"apim\":{\"x-wso2-scopes\":[]}},\"swagger\":\"2.0\",\"info\":{\"title\":\"PhoneVerification\",\"description\":\"Verify a phone number\",\"contact\":{\"email\":\"xx@ee.com\",\"name\":\"xx\"},\"version\":\"2.0.0\"}}", "responseCaching": "Disabled", "isDefaultVersion": false, "gatewayEnvironments": "Production and Sandbox", "businessInformation": { "technicalOwner": "xx", "technicalOwnerEmail": "ggg@ww.com", "businessOwner": "xx", "businessOwnerEmail": "xx@ee.com" }, "transport": [ "http", "https" ], "tags": [ "phone", "multimedia", "verification", "mobile" ], "provider": "admin", "version": "2.0.0", "description": "Use this API to verify a phone number", "name": "PhoneVerification", "context": "/phoneverify", "id": "6fb74674-4ab8-4b52-9886-f9a376985060", "status": "CREATED" }

Sample Response

HTTP/1.1 200 OK Date: Mon, 22 Feb 2016 13:31:35 GMT Content-Type: application/json Transfer-Encoding: chunked Server: WSO2 Carbon Server { "sequences": [], "tiers": [ "Bronze", "Gold" ], "thumbnailUrl": null, "visibility": "PUBLIC", "visibleRoles": [], "visibleTenants": [], "cacheTimeout": 300, "endpointConfig": "{\"production_endpoints\":{\"url\":\" http://ws.cdyne.com/phoneverify/phoneverify.asmx\",\"config\":null},\"endpoint_type\":\"http\"}", "subscriptionAvailability": null, "subscriptionAvailableTenants": [], "destinationStatsEnabled": "Disabled", "apiDefinition": "{\"paths\":{\"\/*\":{\"get\":{\"x-auth-type\":\"Application\",\"x-throttling-tier\":\"Unlimited\",\"responses\":{\"200\":{\"description\":\"OK\"}}}}},\"x-wso2-security\":{\"apim\":{\"x-wso2-scopes\":[]}},\"swagger\":\"2.0\",\"info\":{\"title\":\"PhoneVerification\",\"description\":\"Verify a phone number\",\"contact\":{\"email\":\"xx@ee.com\",\"name\":\"xx\"},\"version\":\"2.0.0\"}}", "responseCaching": "Disabled", "isDefaultVersion": false, "gatewayEnvironments": "Production and Sandbox", "businessInformation": { "technicalOwner": "xx", "technicalOwnerEmail": "ggg@ww.com", "businessOwner": "xx", "businessOwnerEmail": "xx@ee.com" }, "transport": [ "http", "https" ], "tags": [ "phone", "multimedia", "verification", "mobile" ], "provider": "admin", "version": "2.0.0", "description": "Use this API to verify a phone number", "name": "PhoneVerification", "context": "/phoneverify", "id": "6fb74674-4ab8-4b52-9886-f9a376985060", "status": "CREATED" }

Parameters

Type Name Description Schema Default
Path

apiId

required

**API ID** consisting of the **UUID** of the API.\nThe combination of the provider of the API, name of the API and the version is also accepted as a valid API ID.\nShould be formatted as **provider-name-version**.\n

String

Body

body

required

API object that needs to be added\n

API (API)

Header

Content-Type

required

Media type of the entity in the body. Default is JSON.\n

String

JSON

Header

If-Match

optional

Validator for conditional requests; based on ETag.\n

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on Last Modified header.\n

String

Responses

HTTP Code Description Schema

200

OK.\nSuccessful response with updated API object\n

API

400

Bad Request.\nInvalid request or validation error\n

Error

403

Forbidden.\nThe request must be conditional but no condition has been specified.\n

Error

404

Not Found.\nThe resource to be updated does not exist.\n

Error

412

Precondition Failed.\nThe request has not been performed because one of the preconditions is not met.\n

Error

Get API Definition

Get the swagger of an API\n

URL

https://apis.wso2.com/api/am/publisher/v0.9/apis/{apiId}/swagger

HTTP Method

GET

Scope

apim:api_view

CURL Example

curl -H "Authorization: Bearer b0982cd2aacd463ff5f63cd5ebe58f4a" http://127.0.0.1:9763/api/am/publisher/v0.9/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/swagger

Sample Response

HTTP/1.1 200 OK Content-Type: application/json Content-Length: 329 { "paths": {"/*": {"get": { "x-auth-type": "Application", "x-throttling-tier": "Unlimited", "responses": {"200": {"description": "OK"}} }}}, "x-wso2-security": {"apim": {"x-wso2-scopes": []}}, "swagger": "2.0", "info": { "title": "PhoneVerification", "description": "Verify a phone number", "contact": { "email": "xx@ee.com", "name": "xx" }, "version": "1.0.0" } }

Parameters

Type Name Description Schema Default
Path

apiId

required

**API ID** consisting of the **UUID** of the API.\nThe combination of the provider of the API, name of the API and the version is also accepted as a valid API ID.\nShould be formatted as **provider-name-version**.\n

String

Header

Accept

optional

Media types acceptable for the response. Default is JSON.\n

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved\nvariant of the resourec.\n

String

Header

If-Modified-Since

optional

Validator for conditional requests; based on Last Modified header of the\nformerly retrieved variant of the resource.\n

String

Responses

HTTP Code Description Schema

200

OK.\nRequested swagger document of the API is returned\n

304

Not Modified.\nEmpty body because the client has already the latest version of the requested resource.\n

404

Not Found.\nRequested API does not exist.\n

Error

406

Not Acceptable.\nThe requested media type is not supported\n

Error

Update API Definition

Update an existing swagger definition of an API\n

URL

https://apis.wso2.com/api/am/publisher/v0.9/apis/{apiId}/swagger

HTTP Method

PUT

Scope

apim:api_create

CURL Example

curl -k -H "Authorization:Bearer b0982cd2aacd463ff5f63cd5ebe58f4a" -F apiDefinition="{\"paths\":{\"\/*\":{\"get\":{\"x-auth-type\":\"Application\",\"x-throttling-tier\":\"Unlimited\",\"responses\":{\"200\":{\"description\":\"OK\"}}}}},\"x-wso2-security\":{\"apim\":{\"x-wso2-scopes\":[]}},\"swagger\":\"2.0\",\"info\":{\"title\":\"PhoneVerification\",\"description\":\"Verify a phone number\",\"contact\":{\"email\":\"xx@ee.com\",\"name\":\"xx\"},\"version\":\"1.0.0\"}}" -X PUT "http://127.0.0.1:9763/api/am/publisher/v0.9/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/swagger"

Sample Request

{ "paths": { "\/*": { "get": { "x-auth-type": "Application", "x-throttling-tier": "Unlimited", "responses": { "200": { "description": "OK" } } } } }, "x-wso2-security": { "apim": { "x-wso2-scopes": [] } }, "swagger": "2.0", "info": { "title": "PhoneVerification", "description": "Verify a phone number", "contact": { "email": "xx@ee.com", "name": "xx" }, "version": "1.0.0" } }

Sample Response

HTTP/1.1 200 OK Content-Type: application/json { "paths": {"/*": {"get": { "x-auth-type": "Application", "x-throttling-tier": "Unlimited", "responses": {"200": {"description": "OK"}} }}}, "x-wso2-security": {"apim": {"x-wso2-scopes": []}}, "swagger": "2.0", "info": { "title": "PhoneVerification", "description": "Verify a phone number", "contact": { "email": "xx@ee.com", "name": "xx" }, "version": "1.0.0" } }

Parameters

Type Name Description Schema Default
Path

apiId

required

**API ID** consisting of the **UUID** of the API.\nThe combination of the provider of the API, name of the API and the version is also accepted as a valid API ID.\nShould be formatted as **provider-name-version**.\n

String

Form

apiDefinition

required

Swagger definition of the API

String

Header

Content-Type

required

Media type of the entity in the body. Default is JSON.\n

String

JSON

Header

If-Match

optional

Validator for conditional requests; based on ETag.\n

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on Last Modified header.\n

String

Responses

HTTP Code Description Schema

200

OK.\nSuccessful response with updated Swagger definition\n

400

Bad Request.\nInvalid request or validation error\n

Error

403

Forbidden.\nThe request must be conditional but no condition has been specified.\n

Error

404

Not Found.\nThe resource to be updated does not exist.\n

Error

412

Precondition Failed.\nThe request has not been performed because one of the preconditions is not met.\n

Error

Change API Status

Change the lifecycle of an API\n

URL

https://apis.wso2.com/api/am/publisher/v0.9/apis/change-lifecycle

HTTP Method

POST

Scope

apim:api_publish

CURL Example

curl -H "Authorization: Bearer b0982cd2aacd463ff5f63cd5ebe58f4a" -X POST "http://127.0.0.1:9763/api/am/publisher/v0.9/apis/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish"

Sample Response

HTTP/1.1 200 OK

Parameters

Type Name Description Schema Default
Query

action

required

The action to demote or promote the state of the API.\n\nSupported actions are [ **Publish, Deploy as a Prototype, Demote to Created, Demote to Prototyped, Block, Deprecate, Re-Publish, Retire **]\n

Accepted values:

Publish Deploy as a Prototype Demote to Created Demote to Prototyped Block Deprecate Re-Publish Retire
String

Query

apiId

required

**API ID** consisting of the **UUID** of the API.\nThe combination of the provider of the API, name of the API and the version is also accepted as a valid API I.\nShould be formatted as **provider-name-version**.\n

String

Query

lifecycleChecklist

optional

\nYou can specify additional checklist items by using an **\"attribute:\"** modifier.\n\nEg: \"Deprecate Old Versions:true\" will deprecate older versions of a particular API when it is promoted to\nPublished state from Created state. Multiple checklist items can be given in \"attribute1:true, attribute2:false\"\nformat.\n\nSupported checklist items are as follows.\n1. **Deprecate Old Versions**: Setting this to true will deprecate older versions of a particular API when it is promoted to Published state from Created state.\n2. **Require Re-Subscription**: If you set this to true, users need to re subscribe to the API although they may have subscribed to an older version.\n

String

Header

If-Match

optional

Validator for conditional requests; based on ETag.\n

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on Last Modified header.\n

String

Responses

HTTP Code Description Schema

200

OK.\nLifecycle changed successfully.\n

400

Bad Request.\nInvalid request or validation error\n

Error

404

Not Found.\nRequested API does not exist.\n

Error

412

Precondition Failed.\nThe request has not been performed because one of the preconditions is not met.\n

Error

Copy API

Create a new API by copying an existing API\n

URL

https://apis.wso2.com/api/am/publisher/v0.9/apis/copy-api

HTTP Method

POST

Scope

apim:api_create

CURL Example

curl -H "Authorization: Bearer b0982cd2aacd463ff5f63cd5ebe58f4a" -X POST "http://127.0.0.1:9763/api/am/publisher/v0.9/apis/copy-api?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&newVersion=2.0.0"

Sample Response

HTTP/1.1 201 Created Location: http://localhost:9763/api/am/publisher/v0.9/apis/6fb74674-4ab8-4b52-9886-f9a376985060 Content-Type: application/json { "sequences": [], "tiers": [ "Bronze", "Gold" ], "thumbnailUrl": null, "visibility": "PUBLIC", "visibleRoles": [], "visibleTenants": [], "cacheTimeout": 300, "endpointConfig": "{\"production_endpoints\":{\"url\":\" http://ws.cdyne.com/phoneverify/phoneverify.asmx\",\"config\":null},\"endpoint_type\":\"http\"}", "subscriptionAvailability": null, "subscriptionAvailableTenants": [], "destinationStatsEnabled": "Disabled", "apiDefinition": "{\"paths\":{\"\/*\":{\"get\":{\"x-auth-type\":\"Application\",\"x-throttling-tier\":\"Unlimited\",\"responses\":{\"200\":{\"description\":\"OK\"}}}}},\"x-wso2-security\":{\"apim\":{\"x-wso2-scopes\":[]}},\"swagger\":\"2.0\",\"info\":{\"title\":\"PhoneVerification\",\"description\":\"Verify a phone number\",\"contact\":{\"email\":\"xx@ee.com\",\"name\":\"xx\"},\"version\":\"2.0.0\"}}", "responseCaching": "Disabled", "isDefaultVersion": true, "gatewayEnvironments": "Production and Sandbox", "businessInformation": { "technicalOwner": "xx", "technicalOwnerEmail": "ggg@ww.com", "businessOwner": "xx", "businessOwnerEmail": "xx@ee.com" }, "transport": [ "http", "https" ], "tags": [ "phone", "multimedia", "mobile" ], "provider": "admin", "version": "2.0.0", "description": "Verify a phone number", "name": "PhoneVerification", "context": "/phoneverify", "id": "6fb74674-4ab8-4b52-9886-f9a376985060", "status": "CREATED" }

Parameters

Type Name Description Schema Default
Query

newVersion

required

Version of the new API.

String

Query

apiId

required

**API ID** consisting of the **UUID** of the API.\nThe combination of the provider of the API, name of the API and the version is also accepted as a valid API I.\nShould be formatted as **provider-name-version**.\n

String

Responses

HTTP Code Description Schema

201

Created.\nSuccessful response with the newly created API as entity in the body. Location header contains URL of newly created API.\n

400

Bad Request.\nInvalid request or validation error\n

Error

404

Not Found.\nAPI to copy does not exist.\n

Error

Get all APIs\n

Get a list of available APIs qualifying under a given search condition.\n

URL

https://apis.wso2.com/api/am/publisher/v0.9/apis

HTTP Method

GET

Scope

apim:api_view

CURL Example

curl -H "Authorization: Bearer b0982cd2aacd463ff5f63cd5ebe58f4a" http://127.0.0.1:9763/api/am/publisher/v0.9/apis

Sample Response

HTTP/1.1 200 OK Content-Type: application/json { "previous": "", "list": [ { "provider": "admin", "version": "1.0.0", "description": "This sample API provides Account Status Validation", "name": "AccountVal", "context": "/account", "id": "2e81f147-c8a8-4f68-b4f0-69e0e7510b01", "status": "PUBLISHED" }, { "provider": "admin", "version": "1.0.0", "description": null, "name": "api1", "context": "/api1", "id": "3e22d2fb-277a-4e9e-8c7e-1c0f7f73960e", "status": "PUBLISHED" } ], "next": "", "count": 2 }

Parameters

Type Name Description Schema Default
Query

limit

optional

Maximum size of resource array to return.\n

Integer

25

Query

offset

optional

Starting point within the complete list of items qualified.\n

Integer

0

Query

query

optional

**Search condition**.\n\nYou can search in attributes by using an **\"attribute:\"** modifier.\n\nEg. \"provider:wso2\" will match an API if the provider of the API contains \"wso2\".\n\nSupported attribute modifiers are [**version, context, status,\ndescription, subcontext, doc, provider**]\n\nIf no advanced attribute modifier has been specified, search will match the\ngiven query string against API Name.\n

String

Header

Accept

optional

Media types acceptable for the response. Default is JSON.\n

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved\nvariant of the resourec.\n

String

Responses

HTTP Code Description Schema

200

OK.\nList of qualifying APIs is returned.\n

APIList

304

Not Modified.\nEmpty body because the client has already the latest version of the requested resource.\n

406

Not Acceptable.\nThe requested media type is not supported\n

Error

Create a new API

Create a new API\n

URL

https://apis.wso2.com/api/am/publisher/v0.9/apis

HTTP Method

POST

Scope

apim:api_create

CURL Example

curl -H "Authorization: Bearer 40e486e50ce43407181fb4c570d2cac7" -H "Content-Type: application/json" -X POST -d @data.json http://127.0.0.1:9763/api/am/publisher/v0.9/apis

Sample Request

{ "sequences": [], "tiers": [ "Bronze", "Gold" ], "thumbnailUrl": null, "visibility": "PUBLIC", "visibleRoles": [], "visibleTenants": [], "cacheTimeout": 300, "endpointConfig": "{\"production_endpoints\":{\"url\":\" http://ws.cdyne.com/phoneverify/phoneverify.asmx\",\"config\":null},\"endpoint_type\":\"http\"}", "subscriptionAvailability": null, "subscriptionAvailableTenants": [], "destinationStatsEnabled": "Disabled", "apiDefinition": "{\"paths\":{\"\/*\":{\"get\":{\"x-auth-type\":\"Application\",\"x-throttling-tier\":\"Unlimited\",\"responses\":{\"200\":{\"description\":\"OK\"}}}}},\"x-wso2-security\":{\"apim\":{\"x-wso2-scopes\":[]}},\"swagger\":\"2.0\",\"info\":{\"title\":\"PhoneVerification\",\"description\":\"Verify a phone number\",\"contact\":{\"email\":\"xx@ee.com\",\"name\":\"xx\"},\"version\":\"1.0.0\"}}", "responseCaching": "Disabled", "isDefaultVersion": true, "gatewayEnvironments": "Production and Sandbox", "businessInformation": { "technicalOwner": "xx", "technicalOwnerEmail": "ggg@ww.com", "businessOwner": "xx", "businessOwnerEmail": "xx@ee.com" }, "transport": [ "http", "https" ], "tags": [ "phone", "multimedia", "mobile" ], "provider": "admin", "version": "1.0.0", "description": "Verify a phone number", "name": "PhoneVerification", "context": "/phoneverify" }

Sample Response

HTTP/1.1 201 Created Location: http://localhost:9763/api/am/publisher/v0.9/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b Content-Type: application/json { "sequences": [], "tiers": [ "Bronze", "Gold" ], "thumbnailUrl": null, "visibility": "PUBLIC", "visibleRoles": [], "visibleTenants": [], "cacheTimeout": 300, "endpointConfig": "{\"production_endpoints\":{\"url\":\" http://ws.cdyne.com/phoneverify/phoneverify.asmx\",\"config\":null},\"endpoint_type\":\"http\"}", "subscriptionAvailability": null, "subscriptionAvailableTenants": [], "destinationStatsEnabled": "Disabled", "apiDefinition": "{\"paths\":{\"\/*\":{\"get\":{\"x-auth-type\":\"Application\",\"x-throttling-tier\":\"Unlimited\",\"responses\":{\"200\":{\"description\":\"OK\"}}}}},\"x-wso2-security\":{\"apim\":{\"x-wso2-scopes\":[]}},\"swagger\":\"2.0\",\"info\":{\"title\":\"PhoneVerification\",\"description\":\"Verify a phone number\",\"contact\":{\"email\":\"xx@ee.com\",\"name\":\"xx\"},\"version\":\"1.0.0\"}}", "responseCaching": "Disabled", "isDefaultVersion": true, "gatewayEnvironments": "Production and Sandbox", "businessInformation": { "technicalOwner": "xx", "technicalOwnerEmail": "ggg@ww.com", "businessOwner": "xx", "businessOwnerEmail": "xx@ee.com" }, "transport": [ "http", "https" ], "tags": [ "phone", "multimedia", "mobile" ], "provider": "admin", "version": "1.0.0", "description": "Verify a phone number", "name": "PhoneVerification", "context": "/phoneverify", "id": "890a4f4d-09eb-4877-a323-57f6ce2ed79b", "status": "CREATED" }

Parameters

Type Name Description Schema Default
Body

body

required

API object that needs to be added\n

API (API)

Header

Content-Type

required

Media type of the entity in the body. Default is JSON.\n

String

JSON

Responses

HTTP Code Description Schema

201

Created.\nSuccessful response with the newly created object as entity in the body.\nLocation header contains URL of newly created entity.\n

API

400

Bad Request.\nInvalid request or validation error.\n

Error

415

Unsupported Media Type.\nThe entity of the request was in a not supported format.\n

Error