pods · MachineMail Docs

Pods group inboxes, domains and webhooks. Also spelled pod.

Command	Summary
`pods create`	Create pod
`pods delete`	Delete pod
`pods get`	Get pod
`pods list`	List pods
`pods update`	Update pod

Every command also takes the global flags.

pods create

Create pod.

Organization-scoped credentials only: pod and inbox credentials get 403.

Requires the pod_create permission.

shell

machinemail pods create [flags]

Flags

--name <value>string

Name of the pod. Default Untitled pod.

DefaultUntitled pod

--client-id <id>string

Idempotency key: a create with a --client-id already used in the organization returns that pod with 200.

-d, --data <json|@file|->string

Request body as JSON, @file or - for stdin; field flags override its keys.

Examples

shell

machinemail pods create
machinemail pods create --data @body.json

API

POST /v0/pods

pods delete

Delete pod.

Also: machinemail pods rm.

The default pod, and pods that still have inboxes, cannot be deleted (409).

Requires the pod_delete permission.

shell

machinemail pods delete <pod-id> [flags]

Arguments

<pod-id>stringRequired

ID of the pod.

Examples

shell

machinemail pods delete pod_01m4fykg210000x6z8b6wc2rdx

API

DELETE /v0/pods/{pod_id}

pods get

Get pod.

Requires the pod_read permission.

shell

machinemail pods get <pod-id> [flags]

Arguments

<pod-id>stringRequired

ID of the pod.

Examples

shell

machinemail pods get pod_01m4fykg210000x6z8b6wc2rdx

API

GET /v0/pods/{pod_id}

pods list

List pods.

Also: machinemail pods ls.

Requires the pod_read permission.

shell

machinemail pods list [flags]

Flags

--limit <n>integer

Maximum number of items to return. Default 50, maximum 500; larger values are capped.

Default50

--page-token <value>string

next_page_token from the previous page.

--ascendingboolean

Sort oldest first.

--allboolean

Follow next_page_token and return every page.

Examples

shell

machinemail pods list
machinemail pods list --all --json | jq '.pods | length'

API

GET /v0/pods

pods update

Update pod.

Rename the pod.

Requires the pod_update permission.

shell

machinemail pods update <pod-id> [flags]

Arguments

<pod-id>stringRequired

ID of the pod.

Flags

--name <value>string

New name. Must not be blank.

-d, --data <json|@file|->string

Request body as JSON, @file or - for stdin; field flags override its keys.

Examples

shell

machinemail pods update pod_01m4fykg210000x6z8b6wc2rdx
machinemail pods update pod_01m4fykg210000x6z8b6wc2rdx --data @body.json

API

PATCH /v0/pods/{pod_id}