Postman collection
2.1.0Schema URL
Properties
Detailed description of the info block
5 nested properties
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.
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
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.
A Description can be a raw text, or be an object, which holds the description along with its format.
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!
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.
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.
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.
Set of configurations used to alter the usual behavior of sending the request
Definitions
Represents an attribute for any authorization method provided by Postman. For example username and password are set as auth attributes for Basic Authentication method.
Represents authentication helpers provided by Postman
The attributes for API Key Authentication.
The attributes for AWS Auth.
The attributes for Basic Authentication.
The helper attributes for Bearer Token Authentication
The attributes for Digest Authentication.
The attributes for Akamai EdgeGrid Authentication.
The attributes for Hawk Authentication
The attributes for NTLM Authentication
The attributes for OAuth2
Helper attributes for OAuth2
A representation of a list of ssl certificates
A representation of an ssl certificate
A name for the certificate for user reference
A list of Url match pattern strings, to identify Urls this certificate can be used for.
An object containing path to file containing private key, on the file system
1 nested properties
The path to file containing key for certificate, on the file system
An object containing path to file certificate, on the file system
1 nested properties
The path to file containing key for certificate, on the file system
The passphrase for the certificate
A representation of a list of cookies
A Cookie, that follows the Google Chrome format
The domain for which this cookie is valid.
The path associated with the Cookie.
When the cookie expires.
True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie).
Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts)
This is the name of the Cookie.
Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS)
True if the cookie is a session cookie.
The value of the Cookie.
Custom attributes for a cookie go here, such as the Priority Field
A Description can be a raw text, or be an object, which holds the description along with its format.
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.
Defines a script associated with an associated event name
Can be set to test or prerequest for test scripts or pre-request scripts respectively.
A unique identifier for the enclosing event.
A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response.
5 nested properties
A unique, user defined identifier that can be used to refer to this script from requests.
Type of the script. E.g: 'text/javascript'
If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.
Script name
Indicates whether the event is disabled. If absent, the event is assumed to be enabled.
A representation for a list of headers
Represents a single HTTP Header
This holds the LHS of the HTTP Header, e.g Content-Type or X-Custom-Header
The value (or the RHS) of the Header is stored in this field.
If set to true, the current header will not be sent with requests.
A Description can be a raw text, or be an object, which holds the description along with its format.
Detailed description of the info block
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.
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
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.
A Description can be a raw text, or be an object, which holds the description along with its format.
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!
One of the primary goals of Postman is to organize the development of APIs. To this end, it is necessary to be able to group requests together. This can be achived using 'Folders'. A folder just is an ordered set of requests.
Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items.
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.
A Description can be a raw text, or be an object, which holds the description along with its format.
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.
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.
Set of configurations used to alter the usual behavior of sending the request
Items are entities which contain an actual HTTP request, and sample responses attached to it.
A request represents an HTTP request. If a string, the string is assumed to be the request URL and the method is assumed to be 'GET'.
A unique ID that is used to identify collections internally
A human readable identifier for the current item.
A Description can be a raw text, or be an object, which holds the description along with its format.
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.
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.
Set of configurations used to alter the usual behavior of sending the request
Set of configurations used to alter the usual behavior of sending the request
Using the Proxy, you can configure your custom proxy into the postman for particular url match
The Url match for which the proxy config is defined
The proxy server host
The proxy server port
The tunneling details for the proxy config
When set to true, ignores this proxy configuration entity
A request represents an HTTP request. If a string, the string is assumed to be the request URL and the method is assumed to be 'GET'.
A response represents an HTTP response.
A unique, user defined identifier that can be used to refer to this response from requests.
A request represents an HTTP request. If a string, the string is assumed to be the request URL and the method is assumed to be 'GET'.
The time taken by the request to complete. If a number, the unit is milliseconds. If the response is manually created, this can be set to null.
Set of timing information related to request and response in milliseconds
The raw text of the response.
The response status, e.g: '200 OK'
The numerical response code, example: 200, 201, 404, etc.
A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response.
A unique, user defined identifier that can be used to refer to this script from requests.
Type of the script. E.g: 'text/javascript'
If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.
Script name
If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.
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.
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.
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.
A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name.
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
A variable may have multiple types. This field specifies the type of the variable.
Variable name
A Description can be a raw text, or be an object, which holds the description along with its format.
When set to true, indicates that this variable has been set by Postman
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!