ApiBuilder Postman Collection v2.1 0.14.85

Specification of Postman Collection Format v2.1 using the ApiBuilder schema. Further information about Postman Collection Format v2.1 can be found at https://schema.getpostman.com/json/collection/v2.1.0/docs/index.html

  • Contact: N/A
  • License: N/A

Resources

No resources

Headers

No headers

Imports

No imports

Enums

auth_enum

Name Value Description
awsv4 awsv4

basic basic

bearer bearer

digest digest

hawk hawk

noauth noauth

oauth1 oauth1

oauth2 oauth2

ntlm ntlm

body_mode

Name Value Description
raw raw

urlencoded urlencoded

formdata formdata

file file

event_type

Name Value Description
test test

prerequest prerequest

method

Name Value Description
GET GET

PUT PUT

POST POST

PATCH PATCH

DELETE DELETE

COPY COPY

HEAD HEAD

OPTIONS OPTIONS

LINK LINK

UNLINK UNLINK

PURGE PURGE

LOCK LOCK

UNLOCK UNLOCK

PROPFIND PROPFIND

VIEW VIEW

Models

auth

Example Json: Minimal | Full
Field Type Required? Default Description
type auth_enum Yes -

basic [basic_auth] No -

basic_auth

Example Json: Minimal | Full
Field Type Required? Default Description
key string Yes -

value string Yes -

type string No -

body

Example Json: Minimal | Full
Field Type Required? Default Description
raw string No -

mode body_mode No -

urlencoded [url_encoded] No -

file file No -

formdata [form_parameter] No -

collection

Example Json: Minimal | Full
Field Type Required? Default Description
info info Yes -

Detailed description of the info block

item [items] Yes -

Items are the basic unit for a Postman collection. You can think of them as corresponding to a single API endpoint. Each Item has one request and may have multiple API responses associated with it.

event [event] Yes -

Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID.

variable [variable] Yes -

Collection variables allow you to define a set of variables, that are a part of the collection, as opposed to environments, which are separate entities.Note: Collection variables must not contain any sensitive information.

auth auth No -

Represents authentication helpers provided by Postman

description

Example Json: Minimal | Full
Field Type Required? Default Description
content string No -

The content of the description goes here, as a raw string.

type string No -

Holds the mime type of the raw description content. E.g: ‘text/markdown’ or ‘text/html’. The type is used to correctly render the description when generating documentation, or in the Postman app.

event

Example Json: Minimal | Full
Field Type Required? Default Description
listen event_type Yes -

Can be set to test or prerequest for test scripts or pre-request scripts respectively.

script script No -

id string No -

A unique identifier for the enclosing event.

disabled boolean No -

Indicates whether the event is disabled. If absent, the event is assumed to be enabled

file

Example Json: Minimal | Full
Field Type Required? Default Description
src string No -

content string No -

folder

Example Json: Minimal | Full
Field Type Required? Default Description
name string Yes -

A folder’s friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this folder.

description description No -

variable [variable] No -

item [item] Yes -

event [event] No -

auth auth No -

form_parameter

Example Json: Minimal | Full
Field Type Required? Default Description
key string Yes -

value string No -

disabled boolean No -

description description No -

contentType string No -

type string No -

header

Example Json: Minimal | Full
Field Type Required? Default Description
key string Yes -

value string Yes -

disabled boolean No -

description description No -

info

Example Json: Minimal | Full
Field Type Required? Default Description
name string Yes -

A collection’s friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this collection among a bunch of other collections, as such outlining its usage or content.

postman_id string No -

Every collection is identified by the unique value of this field. The value of this field is usually easiest to generate using a UID generator function. If you already have a collection, it is recommended that you maintain the same id since changing the id usually implies that is a different collection than it was originally.Note: This field exists for compatibility reasons with Collection Format V1.

description description No -

A Description can be a raw text, or be an object, which holds the description along with its format.

version string No -

Postman allows you to version your collections as they grow, and this field holds the version number. While optional, it is recommended that you use this field to its fullest extent!

schema string Yes -

This should ideally hold a link to the Postman schema that is used to validate this collection. E.g: https://schema.getpostman.com/collection/v1

item

Example Json: Minimal | Full
Field Type Required? Default Description
id string No -

A unique ID that is used to identify collections internally

name string No -

A human readable identifier for the current item.

description description No -

A Description can be a raw text, or be an object, which holds the description along with its format.

variable [variable] No -

Collection variables allow you to define a set of variables, that are a part of the collection, as opposed to environments, which are separate entities.

event [event] No -

Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID.

request request Yes -

response [response] No -

query_param

Example Json: Minimal | Full
Field Type Required? Default Description
key string No -

value string No -

disabled boolean No -

description description No -

request

Example Json: Minimal | Full
Field Type Required? Default Description
url url No -

auth auth No -

method method No -

description description No -

header [header] No -

body body No -

response

Example Json: Minimal | Full
Field Type Required? Default Description
id string No -

name string No -

originalRequest request No -

responseTime string No -

header [header] No -

body string No -

status string No -

code integer No -

script

Example Json: Minimal | Full
Field Type Required? Default Description
exec [string] Yes -

Body of the script in lines

type string No text/javascript

Type of the script. E.g: ‘text/javascript’

id string No -

A unique, user defined identifier that can be used to refer to this script from requests.

src string No -

If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.

name string No -

Script name

url

Example Json: Minimal | Full
Field Type Required? Default Description
raw string No -

The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s).

protocol string No -

The protocol_ associated with the request, E.g: ‘http’

host [string] No -

The host for the URL, E.g: api.yourdomain.com. Can be stored as a string or as an array of strings.

path [string] No -

port string No -

The port number present in this URL. An empty value implies 80/443 depending on whether the protocol_ field contains http/https.

query [query_param] No -

hash string No -

Contains the URL fragment (if any). Usually this is not transmitted over the network, but it could be useful to store this in some cases.

variable [variable] No -

Postman supports path variables with the syntax /path/:variableName/to/somewhere. These variables are stored in this field.

url_encoded

Example Json: Minimal | Full
Field Type Required? Default Description
key string Yes -

value string No -

disabled boolean No -

description description No -

variable

Example Json: Minimal | Full

Using variables in your Postman requests eliminates the need to duplicate requests, which can save a lot of time. Variables can be defined, and referenced to from any part of a request.

Field Type Required? Default Description
id string No -

A variable ID is a unique user-defined value that identifies the variable within a collection. In traditional terms, this would be a variable name.

key string No -

A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name.

value string No -

The value that a variable holds in this collection. Ultimately, the variables will be replaced by this value, when say running a set of requests from a collection

type string No -

A variable may have multiple types. This field specifies the type of the variable.

name string No -

Variable name

description description No -

system boolean No -

When set to true, indicates that this variable has been set by Postman

disabled boolean No -

Unions

items

  • Type discriminator: type
Type Discriminator Value Example Json Description
item item Minimal | Full

folder folder Minimal | Full

Annotations

No annotations