"description": "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.",
"description": "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.",
"description": "Represents an attribute for any authorization method provided by Postman. For example `username` and `password` are set as auth attributes for Basic Authentication method.",
"description": "Represents authentication helpers provided by Postman",
"description": "Represents authentication helpers provided by Postman",
"properties": {
"properties": {
"type": {
"type": {
"type": "string",
"type": "string",
"enum": [
"enum": [
"apikey",
"apikey",
"awsv4",
"awsv4",
"basic",
"basic",
"bearer",
"bearer",
"digest",
"digest",
"edgegrid",
"edgegrid",
"hawk",
"hawk",
"ntlm",
"noauth",
"noauth",
"oauth1",
"oauth1",
"oauth2"
"oauth2",
"ntlm"
]
]
},
},
"noauth": {},
"noauth": {},
"apikey": {
"apikey": {
"type": "object",
"type": "array",
"title": "API Key Authentication",
"title": "API Key Authentication",
"description": "The attributes for API Key Authentication. e.g. key, value, in."
"description": "The attributes for API Key Authentication.",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"awsv4": {
"awsv4": {
"type": "object",
"type": "array",
"title": "AWS Signature v4",
"title": "AWS Signature v4",
"description": "The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html). e.g. accessKey, secretKey, region, service."
"description": "The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"basic": {
"basic": {
"type": "object",
"type": "array",
"title": "Basic Authentication",
"title": "Basic Authentication",
"description": "The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). e.g. username, password."
"description": "The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"bearer": {
"bearer": {
"type": "object",
"type": "array",
"title": "Bearer Token Authentication",
"title": "Bearer Token Authentication",
"description": "The attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750). e.g. token."
"description": "The helper attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750)",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"digest": {
"digest": {
"type": "object",
"type": "array",
"title": "Digest Authentication",
"title": "Digest Authentication",
"description": "The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication). e.g. username, password, realm, nonce, nonceCount, algorithm, qop, opaque, clientNonce."
"description": "The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication).",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"edgegrid": {
"edgegrid": {
"type": "object",
"type": "array",
"title": "EdgeGrid Authentication",
"title": "EdgeGrid Authentication",
"description": "The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html). e.g. accessToken, clientToken, clientSecret, baseURL, nonce, timestamp, headersToSign."
"description": "The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html).",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"hawk": {
"hawk": {
"type": "object",
"type": "array",
"title": "Hawk Authentication",
"title": "Hawk Authentication",
"description": "The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk). e.g. authId, authKey, algorith, user, nonce, extraData, appId, delegation, timestamp."
"description": "The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk)",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"ntlm": {
"ntlm": {
"type": "object",
"type": "array",
"title": "NTLM Authentication",
"title": "NTLM Authentication",
"description": "The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx). e.g. username, password, domain, workstation."
"description": "The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx)",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"oauth1": {
"oauth1": {
"type": "object",
"type": "array",
"title": "OAuth1",
"title": "OAuth1",
"description": "The attributes for [OAuth1](https://oauth.net/1/). e.g. consumerKey, consumerSecret, token, tokenSecret, signatureMethod, timestamp, nonce, version, realm, encodeOAuthSign."
"description": "The attributes for [OAuth2](https://oauth.net/1/)",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"oauth2": {
"oauth2": {
"type": "object",
"type": "array",
"title": "OAuth2",
"title": "OAuth2",
"description": "The attributes for [OAuth2](https://oauth.net/2/). e.g. accessToken, addTokenTo."
"description": "Helper attributes for [OAuth2](https://oauth.net/2/)",
"description": "A Description can be a raw text, or be an object, which holds the description along with its format.",
"description": "A Description can be a raw text, or be an object, which holds the description along with its format.",
"oneOf": [
"oneOf": [
{
{
"type": "object",
"type": "object",
"title": "Description",
"title": "Description",
"properties": {
"properties": {
"content": {
"content": {
"type": "string",
"type": "string",
"description": "The content of the description goes here, as a raw string."
"description": "The content of the description goes here, as a raw string."
},
},
"type": {
"type": {
"type": "string",
"type": "string",
"description": "Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.\nThe type is used to correctly render the description when generating documentation, or in the Postman app."
"description": "Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.\nThe type is used to correctly render the description when generating documentation, or in the Postman app."
},
},
"version": {
"version": {
"description": "Description can have versions associated with it, which should be put in this property."
"description": "Description can have versions associated with it, which should be put in this property."
"description": "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.",
"description": "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.",
"description": "Detailed description of the info block",
"description": "Detailed description of the info block",
"type": "object",
"type": "object",
"properties": {
"properties": {
"name": {
"name": {
"type": "string",
"type": "string",
"title": "Name of the collection",
"title": "Name of the collection",
"description": "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."
"description": "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": {
"_postman_id": {
"type": "string",
"type": "string",
"description": "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.\n *Note: This field exists for compatibility reasons with Collection Format V1.*"
"description": "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.\n *Note: This field exists for compatibility reasons with Collection Format V1.*"
},
},
"description": {
"description": {
"$ref": "#/definitions/description"
"$ref": "#/definitions/description"
},
},
"version": {
"version": {
"$ref": "#/definitions/version"
"$ref": "#/definitions/version"
},
},
"schema": {
"schema": {
"description": "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",
"description": "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",
"description": "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.",
"description": "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.",
"type": "object",
"type": "object",
"properties": {
"properties": {
"name": {
"name": {
"type": "string",
"type": "string",
"description": "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": "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": {
"$ref": "#/definitions/description"
"$ref": "#/definitions/description"
},
},
"variable": {
"variable": {
"$ref": "#/definitions/variable-list"
"$ref": "#/definitions/variable-list"
},
},
"item": {
"item": {
"description": "Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items.",
"description": "Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items.",
"description": "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'.",
"description": "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'.",
"oneOf": [
"oneOf": [
{
{
"type": "object",
"type": "object",
"title": "Request",
"title": "Request",
"properties": {
"properties": {
"url": {
"url": {
"$ref": "#/definitions/url"
"$ref": "#/definitions/url"
},
},
"auth": {
"auth": {
"oneOf": [
"oneOf": [
{
{
"type": "null"
"type": "null"
},
},
{
{
"$ref": "#/definitions/auth"
"$ref": "#/definitions/auth"
}
}
]
]
},
},
"proxy": {
"proxy": {
"$ref": "#/definitions/proxy-config"
"$ref": "#/definitions/proxy-c
},
"certificate": {
"$ref": "#/definitions/certificate"
},
"method": {
"anyOf": [
{
"description": "The Standard HTTP method associated with this request.",
"type": "string",
"enum": [
"GET",
"PUT",
"POST",
"PATCH",
"DELETE",
"COPY",
"HEAD",
"OPTIONS",
"LINK",
"UNLINK",
"PURGE",
"LOCK",
"UNLOCK",
"PROPFIND",
"VIEW"
]
},
{
"description": "The Custom HTTP method associated with this request.",