Create API

POST

/apis

API

This call creates a new API with a default API Version.

Request body should contain an api object which should atleast have a property name.

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 POST 'https://api.getpostman.com/apis' \
--header 'Content-Type: application/json' \
--data-raw '{
    "api": {
        "description": "This is description.",
        "name": "Sync Service API",
        "summary": "This is supposed to be a short summary."
    }
}'

Response Example

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

Request

Query Params

workspace

string

optional

Body Params application/json

api

object

optional

description

string

optional

Example:

This is description.

name

string

optional

Example:

Sync Service API

summary

string

optional

Example:

This is supposed to be a short summary.

Examples

Responses

🟢200Create 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 supposed to handle markdown *descriptions*.

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

Get all APIs

Delete an API