Skip to main content
Postman logo

​
Overview

Add Postman to any ModuleX agent or workflow. API development and testing platform for building, monitoring, and managing APIs against the Postman REST API (api.getpostman.com).
Categories: Developer Tools & Infrastructure · Api Testing · Auth: API Key · Actions: 4

​
Authentication

​
API Key Authentication

Authenticate using your Postman API key
1

Step 1

Go to https://web.postman.co and sign in
2

Step 2

Click your avatar in the top-right, then select Settings
3

Step 3

Navigate to the ‘API Keys’ tab
4

Step 4

Generate a new API key or copy your existing one
5

Step 5

Paste the API key below

​
Required Credentials

FieldDescriptionRequiredFormat
Postman API KeyYour Postman API key from web.postman.co/settings/me/api-keysYesPMAK-xxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
Available Actions

​
Parameters

​
environment_name
string
required
The name for the new environment
​
workspace_id
string
The ID of the workspace to create the environment in
​
variables
array
List of variable objects with keys: key (string), value (string), enabled (boolean), type (‘secret’ or ‘default’)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "environment_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Environment Id"
    },
    "environment_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Environment Name"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateEnvironmentOutput",
  "type": "object"
}

​
Response

{
  "$defs": {
    "WorkspaceSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Type"
        }
      },
      "title": "WorkspaceSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "workspaces": {
      "items": {
        "$ref": "#/$defs/WorkspaceSummary"
      },
      "title": "Workspaces",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListWorkspaceIdOptionsOutput",
  "type": "object"
}

​
Parameters

​
monitor_id
string
required
The ID of the monitor to run

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "run": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Run"
    }
  },
  "required": [
    "success"
  ],
  "title": "RunMonitorOutput",
  "type": "object"
}

​
Parameters

​
environment_id
string
required
The ID of the environment containing the variable
​
variable
string
required
The variable key (name) to update
​
variable_value
string
required
The new value for the variable
​
workspace_id
string
The ID of the workspace containing the environment
​
variable_enabled
boolean
Whether the variable is enabled or not

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "environment_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Environment Id"
    },
    "environment_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Environment Name"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateVariableOutput",
  "type": "object"
}

​
Limits & Quotas

Algolia

Amazon Web Services

Apify