Skip to main content
PUT
/
products
/
{product_id}
/
api-details
/
{api-id}
Update description of an API
curl --request PUT \
  --url http://localhost:3001/portal-api/products/{product_id}/api-details/{api-id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Description": "This API provides payment endpoints",
  "Name": "Payment API",
  "OASUrl": "https://petstore.swagger.io/v2/swagger.json",
  "Status": true
}
'
{
  "APIType": "authToken",
  "Description": "This API provides payment endpoints",
  "ListenPath": "/payments/",
  "Name": "Payment API",
  "OASUrl": "https://petstore.swagger.io/v2/swagger.json",
  "Status": true,
  "TargetURL": "http://httpbin.org/"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
api-id
string
required

UID of an API as it comes from the API Provider

Example:

"a0ce49d559ce49d64fe608ea3728082a"

​
product_id
integer
required

UID of an API Product

Example:

1

Body

application/json
​
Description
string

Human-readable description of an API added by the portal admins

Example:

"This API provides payment endpoints"

​
Name
string

Name of an API as it is defined in the gateway

Example:

"Payment API"

​
OASUrl
string

URL of OpenAPI Specification for this API. The document must be a valid OAS document

Example:

"https://petstore.swagger.io/v2/swagger.json"

​
Status
boolean

Status of this API: true means the API is up and false identifies that it is down

Example:

true

Response

200 - application/json

OK

​
APIType
string

Authentication type of an API

Example:

"authToken"

​
Description
string

Human-readable description of an API added by the portal admins

Example:

"This API provides payment endpoints"

​
ListenPath
string

Listen path which is defined for this API in the gateway

Example:

"/payments/"

​
Name
string

Name of an API as it is defined in the gateway

Example:

"Payment API"

​
OASUrl
string

URL of OpenAPI Specification for this API. The document must be a valid OAS document

Example:

"https://petstore.swagger.io/v2/swagger.json"

​
Status
boolean

Status of this API: true means the API is up and false identifies that it is down

Example:

true

​
TargetURL
string

Upstream URL of this API

Example:

"http://httpbin.org/"