Update an API

PUT

/apis/{apiId}

API

This call updates an existing API .

Request body should contain an api object which should have the fields to be updated. Only name, summary and description fields can be edited for an API.

Response contains an api object with all the details related to the created API, namely, id, name, summary, description etc.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.getpostman.com/apis/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "api": {
        "description": "This is an updated Description",
        "name": "New name"
    }
}'

Response Example

{
  "api": {
    "createdAt": "2019-02-12T19:34:49.000Z",
    "createdBy": "5665",
    "description": "This is a description.",
    "id": "387c2863-6ee3-4a56-8210-225f774edade",
    "name": "Sync API",
    "summary": "This is a summary",
    "updatedAt": "2019-02-12T19:34:49.000Z"
  }
}

Request

Path Params

apiId

string

required

Body Params application/json

api

object

optional

description

string

optional

Example:

This is an updated Description

name

string

optional

Example:

New name

Examples

Responses

🟢200Update an API

application/json

Body

api

object

optional

createdAt

string

optional

Example:

2019-02-12T19:34:49.000Z

createdBy

string

optional

Example:

5665

description

string

optional

Example:

This is a description.

string

optional

Example:

387c2863-6ee3-4a56-8210-225f774edade

name

string

optional

Example:

Sync API

summary

string

optional

Example:

This is a summary

updatedAt

string

optional

Example:

2019-02-12T19:34:49.000Z

Modified at 2023-08-15 05:41:03

Single API

Get All API Versions