Icon

Postman (version v1.*.*)

create_collection

Create collections using the Postman Collection v2 format.

Parameters

$body

Type: object

{
"collection" : {
"item" : [ {
"request" : {
"proxy" : {
"port" : "The proxy server port",
"match" : "The Url match for which the proxy config is defined",
"host" : "The proxy server host",
"disabled" : "When set to true, ignores this proxy configuration entity",
"tunnel" : "The tunneling details for the proxy config"
},
"method" : { },
"auth" : {
"apikey" : { },
"ntlm" : { },
"awsv4" : { },
"noauth" : { },
"digest" : { },
"bearer" : { },
"type" : "string. Possible values: apikey | awsv4 | basic | bearer | digest | hawk | ntlm | noauth | oauth1 | oauth2",
"basic" : { },
"oauth2" : { },
"hawk" : { },
"oauth1" : { }
},
"certificate" : {
"name" : "A name for the certificate for user reference",
"cert" : {
"src" : { }
},
"passphrase" : "The passphrase for the certificate",
"matches" : [ "An Url match pattern string" ],
"key" : {
"src" : { }
}
},
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"header" : { },
"body" : {
"mode" : { },
"file" : {
"src" : "string",
"content" : "string"
},
"urlencoded" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "boolean",
"value" : "string",
"key" : "string"
} ],
"raw" : "string",
"disabled" : "When set to true, prevents request body from being sent.",
"formdata" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "When set to true, prevents this form data entity from being sent.",
"type" : "string. Possible values: text",
"value" : "string",
"contentType" : "Override Content-Type header of this form data entity.",
"key" : "string"
} ],
"graphql" : { }
},
"url" : {
"path" : { },
"protocol" : "The protocol associated with the request, E.g: 'http'",
"port" : "The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https.",
"query" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "If set to true, the current query parameter will not be sent with the request.",
"value" : "string",
"key" : "string"
} ],
"host" : { },
"variable" : [ {
"system" : "When set to true, indicates that this variable has been set by Postman",
"name" : "Variable name",
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "boolean",
"id" : "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.",
"type" : "A variable may have multiple types. This field specifies the type of the variable.",
"value" : { },
"key" : "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name."
} ],
"raw" : "The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s).",
"hash" : "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."
}
},
"protocolProfileBehavior" : { },
"response" : [ {
"originalRequest" : {
"proxy" : {
"port" : "The proxy server port",
"match" : "The Url match for which the proxy config is defined",
"host" : "The proxy server host",
"disabled" : "When set to true, ignores this proxy configuration entity",
"tunnel" : "The tunneling details for the proxy config"
},
"method" : { },
"auth" : {
"apikey" : { },
"ntlm" : { },
"awsv4" : { },
"noauth" : { },
"digest" : { },
"bearer" : { },
"type" : "string. Possible values: apikey | awsv4 | basic | bearer | digest | hawk | ntlm | noauth | oauth1 | oauth2",
"basic" : { },
"oauth2" : { },
"hawk" : { },
"oauth1" : { }
},
"certificate" : {
"name" : "A name for the certificate for user reference",
"cert" : {
"src" : { }
},
"passphrase" : "The passphrase for the certificate",
"matches" : [ "An Url match pattern string" ],
"key" : {
"src" : { }
}
},
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"header" : { },
"body" : {
"mode" : { },
"file" : {
"src" : "string",
"content" : "string"
},
"urlencoded" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "boolean",
"value" : "string",
"key" : "string"
} ],
"raw" : "string",
"disabled" : "When set to true, prevents request body from being sent.",
"formdata" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "When set to true, prevents this form data entity from being sent.",
"type" : "string. Possible values: text",
"value" : "string",
"contentType" : "Override Content-Type header of this form data entity.",
"key" : "string"
} ],
"graphql" : { }
},
"url" : {
"path" : { },
"protocol" : "The protocol associated with the request, E.g: 'http'",
"port" : "The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https.",
"query" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "If set to true, the current query parameter will not be sent with the request.",
"value" : "string",
"key" : "string"
} ],
"host" : { },
"variable" : [ {
"system" : "When set to true, indicates that this variable has been set by Postman",
"name" : "Variable name",
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "boolean",
"id" : "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.",
"type" : "A variable may have multiple types. This field specifies the type of the variable.",
"value" : { },
"key" : "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name."
} ],
"raw" : "The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s).",
"hash" : "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."
}
},
"code" : "The numerical response code, example: 200, 201, 404, etc.",
"cookie" : [ {
"path" : "The path associated with the Cookie.",
"expires" : { },
"extensions" : [ { } ],
"maxAge" : "string",
"session" : "True if the cookie is a session cookie.",
"domain" : "The domain for which this cookie is valid.",
"hostOnly" : "True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie).",
"name" : "This is the name of the Cookie.",
"httpOnly" : "Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts)",
"secure" : "Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS)",
"value" : "The value of the Cookie."
} ],
"responseTime" : { },
"timings" : { },
"header" : { },
"id" : "A unique, user defined identifier that can be used to refer to this response from requests.",
"body" : "The raw text of the response.",
"status" : "The response status, e.g: '200 OK'"
} ],
"name" : "A human readable identifier for the current item.",
"variable" : [ {
"system" : "When set to true, indicates that this variable has been set by Postman",
"name" : "Variable name",
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "boolean",
"id" : "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.",
"type" : "A variable may have multiple types. This field specifies the type of the variable.",
"value" : { },
"key" : "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name."
} ],
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"id" : "A unique ID that is used to identify collections internally",
"event" : [ {
"disabled" : "Indicates whether the event is disabled. If absent, the event is assumed to be enabled.",
"id" : "A unique identifier for the enclosing event.",
"listen" : "Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively.",
"script" : {
"src" : {
"path" : { },
"protocol" : "The protocol associated with the request, E.g: 'http'",
"port" : "The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https.",
"query" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "If set to true, the current query parameter will not be sent with the request.",
"value" : "string",
"key" : "string"
} ],
"host" : { },
"variable" : [ {
"system" : "When set to true, indicates that this variable has been set by Postman",
"name" : "Variable name",
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "boolean",
"id" : "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.",
"type" : "A variable may have multiple types. This field specifies the type of the variable.",
"value" : { },
"key" : "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name."
} ],
"raw" : "The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s).",
"hash" : "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."
},
"name" : "Script name",
"id" : "A unique, user defined identifier that can be used to refer to this script from requests.",
"type" : "Type of the script. E.g: 'text/javascript'",
"exec" : { }
}
} ]
} ],
"info" : {
"schema" : "string",
"name" : "string",
"description" : "string"
}
}
}

create_environment

Create an environment.

Parameters

$body

Type: object

{
"environment" : {
"values" : [ {
"value" : "string",
"key" : "string",
"enabled" : "boolean"
} ],
"name" : "string"
}
}

create_mock

Create a mock. You can also provide an environment UID to resolve any environment variables in the collection. You can also specify the context of a workspace to create a mock in directly by passing the workspace as a query param.

Parameters

$body

Type: object

{
"mock" : {
"environment" : "string",
"collection" : "string"
}
}

create_monitor

Create monitors using the Postman Monitor v2 format.

Parameters

$body

Type: object

{
"monitor" : {
"schedule" : {
"cron" : "string",
"timezone" : "string"
},
"environment" : "string",
"name" : "string",
"collection" : "string"
}
}

create_workspace

Create workspace.

Parameters

$body

Type: object

{
"workspace" : {
"collections" : [ {
"uid" : "string",
"name" : "string",
"id" : "string"
} ],
"environments" : [ {
"uid" : "string",
"name" : "string",
"id" : "string"
} ],
"name" : "string",
"description" : "string",
"mocks" : [ {
"id" : "string"
} ],
"type" : "string",
"monitors" : [ {
"id" : "string"
} ]
}
}

delete_collection

Delete an existing collection.

Parameters

collection-id (required)

Type: string

delete_environment

Delete an existing environment.

Parameters

environment-id (required)

Type: string

delete_mock

Delete an existing mock.

Parameters

mock-id (required)

Type: string

delete_monitor

Delete an existing monitor.

Parameters

monitor-id (required)

Type: string

delete_workspace

Delete an existing workspace.

Parameters

workspace-id (required)

Type: string

get_collection

Access the contents of a collection that is accessible to you using its unique id.

Parameters

collection-id (required)

Type: string

get_environment

Access the contents of a environment that is accessible to you using its unique id.

Parameters

environment-id (required)

Type: string

get_mock

Access the contents of a mock that is accessible to you using its unique id.

Parameters

mock-id (required)

Type: string

get_monitor

Access the contents of a monitor that is accessible to you using its unique id.

Parameters

monitor-id (required)

Type: string

get_owner

This operation has no parameters

get_workspace

Access the contents of a workspace that is accessible to you using its unique id.

Parameters

workspace-id (required)

Type: string

import_exported_data

Import your exported Postman data.

Parameters

$body

Type: object

{
"input" : "Exported Postman data.",
"type" : "string"
}

import_external_api_spec

Import external API specifications into Postman.

Parameters

$body

Type: object

{
"input" : "OpenAPI specification in JSON format.",
"type" : "string"
}

list_collections

This operation has no parameters

list_environments

This operation has no parameters

list_mocks

This operation has no parameters

list_monitors

This operation has no parameters

list_workspaces

This operation has no parameters

run_monitor

Run the monitor instantly and wait for the monitor to run completely. It responds with the run results.

Parameters

monitor-id (required)

Type: string

update_collection

update an existing collection using the Postman Collection v2 format.

Parameters

collection-id (required)

Type: string

$body

Type: object

{
"collection" : {
"item" : [ {
"request" : {
"proxy" : {
"port" : "The proxy server port",
"match" : "The Url match for which the proxy config is defined",
"host" : "The proxy server host",
"disabled" : "When set to true, ignores this proxy configuration entity",
"tunnel" : "The tunneling details for the proxy config"
},
"method" : { },
"auth" : {
"apikey" : { },
"ntlm" : { },
"awsv4" : { },
"noauth" : { },
"digest" : { },
"bearer" : { },
"type" : "string. Possible values: apikey | awsv4 | basic | bearer | digest | hawk | ntlm | noauth | oauth1 | oauth2",
"basic" : { },
"oauth2" : { },
"hawk" : { },
"oauth1" : { }
},
"certificate" : {
"name" : "A name for the certificate for user reference",
"cert" : {
"src" : { }
},
"passphrase" : "The passphrase for the certificate",
"matches" : [ "An Url match pattern string" ],
"key" : {
"src" : { }
}
},
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"header" : { },
"body" : {
"mode" : { },
"file" : {
"src" : "string",
"content" : "string"
},
"urlencoded" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "boolean",
"value" : "string",
"key" : "string"
} ],
"raw" : "string",
"disabled" : "When set to true, prevents request body from being sent.",
"formdata" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "When set to true, prevents this form data entity from being sent.",
"type" : "string. Possible values: text",
"value" : "string",
"contentType" : "Override Content-Type header of this form data entity.",
"key" : "string"
} ],
"graphql" : { }
},
"url" : {
"path" : { },
"protocol" : "The protocol associated with the request, E.g: 'http'",
"port" : "The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https.",
"query" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "If set to true, the current query parameter will not be sent with the request.",
"value" : "string",
"key" : "string"
} ],
"host" : { },
"variable" : [ {
"system" : "When set to true, indicates that this variable has been set by Postman",
"name" : "Variable name",
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "boolean",
"id" : "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.",
"type" : "A variable may have multiple types. This field specifies the type of the variable.",
"value" : { },
"key" : "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name."
} ],
"raw" : "The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s).",
"hash" : "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."
}
},
"protocolProfileBehavior" : { },
"response" : [ {
"originalRequest" : {
"proxy" : {
"port" : "The proxy server port",
"match" : "The Url match for which the proxy config is defined",
"host" : "The proxy server host",
"disabled" : "When set to true, ignores this proxy configuration entity",
"tunnel" : "The tunneling details for the proxy config"
},
"method" : { },
"auth" : {
"apikey" : { },
"ntlm" : { },
"awsv4" : { },
"noauth" : { },
"digest" : { },
"bearer" : { },
"type" : "string. Possible values: apikey | awsv4 | basic | bearer | digest | hawk | ntlm | noauth | oauth1 | oauth2",
"basic" : { },
"oauth2" : { },
"hawk" : { },
"oauth1" : { }
},
"certificate" : {
"name" : "A name for the certificate for user reference",
"cert" : {
"src" : { }
},
"passphrase" : "The passphrase for the certificate",
"matches" : [ "An Url match pattern string" ],
"key" : {
"src" : { }
}
},
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"header" : { },
"body" : {
"mode" : { },
"file" : {
"src" : "string",
"content" : "string"
},
"urlencoded" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "boolean",
"value" : "string",
"key" : "string"
} ],
"raw" : "string",
"disabled" : "When set to true, prevents request body from being sent.",
"formdata" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "When set to true, prevents this form data entity from being sent.",
"type" : "string. Possible values: text",
"value" : "string",
"contentType" : "Override Content-Type header of this form data entity.",
"key" : "string"
} ],
"graphql" : { }
},
"url" : {
"path" : { },
"protocol" : "The protocol associated with the request, E.g: 'http'",
"port" : "The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https.",
"query" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "If set to true, the current query parameter will not be sent with the request.",
"value" : "string",
"key" : "string"
} ],
"host" : { },
"variable" : [ {
"system" : "When set to true, indicates that this variable has been set by Postman",
"name" : "Variable name",
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "boolean",
"id" : "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.",
"type" : "A variable may have multiple types. This field specifies the type of the variable.",
"value" : { },
"key" : "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name."
} ],
"raw" : "The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s).",
"hash" : "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."
}
},
"code" : "The numerical response code, example: 200, 201, 404, etc.",
"cookie" : [ {
"path" : "The path associated with the Cookie.",
"expires" : { },
"extensions" : [ { } ],
"maxAge" : "string",
"session" : "True if the cookie is a session cookie.",
"domain" : "The domain for which this cookie is valid.",
"hostOnly" : "True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie).",
"name" : "This is the name of the Cookie.",
"httpOnly" : "Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts)",
"secure" : "Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS)",
"value" : "The value of the Cookie."
} ],
"responseTime" : { },
"timings" : { },
"header" : { },
"id" : "A unique, user defined identifier that can be used to refer to this response from requests.",
"body" : "The raw text of the response.",
"status" : "The response status, e.g: '200 OK'"
} ],
"name" : "A human readable identifier for the current item.",
"variable" : [ {
"system" : "When set to true, indicates that this variable has been set by Postman",
"name" : "Variable name",
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "boolean",
"id" : "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.",
"type" : "A variable may have multiple types. This field specifies the type of the variable.",
"value" : { },
"key" : "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name."
} ],
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"id" : "A unique ID that is used to identify collections internally",
"event" : [ {
"disabled" : "Indicates whether the event is disabled. If absent, the event is assumed to be enabled.",
"id" : "A unique identifier for the enclosing event.",
"listen" : "Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively.",
"script" : {
"src" : {
"path" : { },
"protocol" : "The protocol associated with the request, E.g: 'http'",
"port" : "The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https.",
"query" : [ {
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "If set to true, the current query parameter will not be sent with the request.",
"value" : "string",
"key" : "string"
} ],
"host" : { },
"variable" : [ {
"system" : "When set to true, indicates that this variable has been set by Postman",
"name" : "Variable name",
"description" : {
"type" : "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" : { },
"content" : "The content of the description goes here, as a raw string."
},
"disabled" : "boolean",
"id" : "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.",
"type" : "A variable may have multiple types. This field specifies the type of the variable.",
"value" : { },
"key" : "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name."
} ],
"raw" : "The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s).",
"hash" : "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."
},
"name" : "Script name",
"id" : "A unique, user defined identifier that can be used to refer to this script from requests.",
"type" : "Type of the script. E.g: 'text/javascript'",
"exec" : { }
}
} ]
} ],
"info" : {
"schema" : "string",
"name" : "string",
"description" : "string"
}
}
}

update_environment

Update an existing environment.

Parameters

environment-id (required)

Type: string

$body

Type: object

{
"environment" : {
"values" : [ {
"value" : "string",
"key" : "string",
"enabled" : "boolean"
} ],
"name" : "string"
}
}

update_monitor

update an existing monitor using the Postman Monitor v2 format.

Parameters

monitor-id (required)

Type: string

$body

Type: object

{
"monitor" : {
"schedule" : {
"cron" : "string",
"timezone" : "string"
},
"environment" : "string",
"name" : "string",
"collection" : "string"
}
}

update_workspace

Update an existing workspace.

Parameters

workspace-id (required)

Type: string

$body

Type: object

{
"workspace" : {
"collections" : [ {
"uid" : "string",
"name" : "string",
"id" : "string"
} ],
"environments" : [ {
"uid" : "string",
"name" : "string",
"id" : "string"
} ],
"name" : "string",
"description" : "string",
"mocks" : [ {
"id" : "string"
} ],
"type" : "string",
"monitors" : [ {
"id" : "string"
} ]
}
}