R4
Browse docs+

Machine Endpoint Inventory

This page is the audited route inventory for the machine API controllers currently registered in MachineApi.

Use it when you want to confirm whether a route exists even if the quick index only links to common tasks or a dedicated endpoint walkthrough has not been written yet.

All paths are shown relative to https://r4.dev. Every request still needs the correct API key scope, machine permission, and any additional asset or tenant-role checks.

Vaults and Secrets

Vault

  • POST /api/v1/machine/vault
  • GET /api/v1/machine/vault
  • GET /api/v1/machine/vault/sync
  • GET /api/v1/machine/vault/vaults-data
  • GET /api/v1/machine/vault/shared-items
  • POST /api/v1/machine/vault/public-key
  • GET /api/v1/machine/vault/:vaultId/wrapped-key
  • GET /api/v1/machine/vault/:vaultId/public-keys
  • GET /api/v1/machine/vault/:vaultId
  • PATCH /api/v1/machine/vault/:id/update
  • DELETE /api/v1/machine/vault/:vaultId
  • POST /api/v1/machine/vault/:vaultId/items
  • GET /api/v1/machine/vault/:vaultId/items
  • GET /api/v1/machine/vault/:vaultId/fields/:fieldId
  • GET /api/v1/machine/vault/:vaultId/items/:itemId
  • DELETE /api/v1/machine/vault/:vaultId/items/:itemId

Vault Item

  • POST /api/v1/machine/vault-item/:id/add-license-activity
  • GET /api/v1/machine/vault-item/:id/license-activity-manager
  • GET /api/v1/machine/vault-item/:id/vault-activity
  • POST /api/v1/machine/vault-item/:id/log-vault-activity
  • GET /api/v1/machine/vault-item/:id/change-log
  • GET /api/v1/machine/vault-item/:id/field-instance/:fieldInstanceId/secret
  • POST /api/v1/machine/vault-item/:id/associate-with-license
  • PATCH /api/v1/machine/vault-item/:id/update
  • PATCH /api/v1/machine/vault-item/:id/move

Vault Group

  • POST /api/v1/machine/vault-group/:id/ungroup-vault
  • POST /api/v1/machine/vault-group/:id/add-vault-to-group
  • POST /api/v1/machine/vault-group/create
  • POST /api/v1/machine/vault-group/:id/ungroup-group
  • PATCH /api/v1/machine/vault-group/:id/update
  • PATCH /api/v1/machine/vault-group/:id/archive
  • POST /api/v1/machine/vault-group/:id/add-group-to-group

Vault Import

  • POST /api/v1/machine/vault-import/:id/bulk-import
  • POST /api/v1/machine/vault-import/bulk-import-multi

Wrapped Key

  • GET /api/v1/machine/wrapped-key/vault/:vaultId/me
  • POST /api/v1/machine/wrapped-key/vault/:vaultId
  • DELETE /api/v1/machine/wrapped-key/vault/:vaultId/user/:userKeyPairId
  • GET /api/v1/machine/wrapped-key/vault/:vaultId/all
  • GET /api/v1/machine/wrapped-key/vault/:vaultId/agent-encryption-keys
  • GET /api/v1/machine/wrapped-key/pending
  • POST /api/v1/machine/wrapped-key/vault/:vaultId/rekey

User Key Pair

  • POST /api/v1/machine/user-key-pair/register
  • GET /api/v1/machine/user-key-pair/me
  • GET /api/v1/machine/user-key-pair/directory
  • GET /api/v1/machine/user-key-pair/vault/:vaultId
  • POST /api/v1/machine/user-key-pair/backup
  • GET /api/v1/machine/user-key-pair/backup
  • PATCH /api/v1/machine/user-key-pair/revoke

Attachments

  • GET /api/v1/machine/attachments/:id/initialize-multipart-upload
  • POST /api/v1/machine/attachments/:id/get-multipart-pre-signed-urls
  • POST /api/v1/machine/attachments/:id/finalize-multipart-upload
  • POST /api/v1/machine/attachments/:id/create
  • PATCH /api/v1/machine/attachments/:id/assets/:assetId/finish-upload
  • PATCH /api/v1/machine/attachments/:id/assets/:assetId/update
  • PATCH /api/v1/machine/attachments/:id/assets/:assetId/archive
  • GET /api/v1/machine/attachments/:id/assets/:assetId/signed-url
  • GET /api/v1/machine/attachments/:id/assets/:assetId/download-ticket

Projects, Agents, and Permissions

Identity

  • GET /api/v1/machine/me
  • POST /api/v1/machine/search

Project

  • GET /api/v1/machine/project
  • POST /api/v1/machine/project
  • GET /api/v1/machine/project/:id
  • PATCH /api/v1/machine/project/update
  • POST /api/v1/machine/project/archive
  • POST /api/v1/machine/project/restore
  • POST /api/v1/machine/project/associate-vault
  • POST /api/v1/machine/project/associate-license-group
  • POST /api/v1/machine/project/associate-license-instance
  • POST /api/v1/machine/project/associate-manual-license
  • GET /api/v1/machine/project/project/:id/members
  • PATCH /api/v1/machine/project/project/:id/update-members
  • GET /api/v1/machine/project/project/:id/agents
  • PATCH /api/v1/machine/project/project/:id/update-agents

Agent

  • GET /api/v1/machine/agent
  • POST /api/v1/machine/agent
  • GET /api/v1/machine/agent/:id
  • PATCH /api/v1/machine/agent/:id
  • PATCH /api/v1/machine/agent/:id/archive
  • POST /api/v1/machine/agent/:id/regenerate-api-key
  • PATCH /api/v1/machine/agent/:id/vault-item
  • GET /api/v1/machine/agent/:id/tenant-roles
  • PATCH /api/v1/machine/agent/:id/tenant-roles

Feedback

  • POST /api/v1/machine/feedback

Marketplace

  • GET /api/v1/machine/marketplace/catalog/all
  • GET /api/v1/machine/marketplace/catalog/:slug/detail
  • GET /api/v1/machine/marketplace/catalog/search
  • GET /api/v1/machine/marketplace/catalog/filter
  • GET /api/v1/machine/marketplace/catalog/filter-data
  • GET /api/v1/machine/marketplace/:id/order-data
  • POST /api/v1/machine/marketplace/quote
  • POST /api/v1/machine/marketplace/create-cart
  • POST /api/v1/machine/marketplace/add-to-cart
  • GET /api/v1/machine/marketplace/:id/cart
  • GET /api/v1/machine/marketplace/:id/cart-item-units
  • GET /api/v1/machine/marketplace/my-carts
  • GET /api/v1/machine/marketplace/past-carts
  • POST /api/v1/machine/marketplace/archive-cart
  • PATCH /api/v1/machine/marketplace/:id/remove-from-cart
  • POST /api/v1/machine/marketplace/checkout

Webhooks

  • GET /api/v1/machine/webhook
  • GET /api/v1/machine/webhook/:id
  • POST /api/v1/machine/webhook
  • PATCH /api/v1/machine/webhook/:id
  • POST /api/v1/machine/webhook/:id/rotate-secret
  • POST /api/v1/machine/webhook/:id/test
  • GET /api/v1/machine/webhook/:id/deliveries
  • POST /api/v1/machine/webhook/:id/archive

Permissions

  • GET /api/v1/machine/permissions/:id/access
  • GET /api/v1/machine/permissions/:assetType/warning-message
  • GET /api/v1/machine/permissions/security-groups
  • GET /api/v1/machine/permissions/tenant-members
  • GET /api/v1/machine/permissions/projects
  • GET /api/v1/machine/permissions/agents
  • GET /api/v1/machine/permissions/:assetType/:id/permissions
  • GET /api/v1/machine/permissions/:assetType/:id/resolved-access
  • POST /api/v1/machine/permissions/:assetType/:id/set-permissions

Domains and DNS

Budget

  • POST /api/v1/machine/budget
  • GET /api/v1/machine/budget

Domain

  • POST /api/v1/machine/domain/add
  • GET /api/v1/machine/domain/list
  • POST /api/v1/machine/domain/:id/verify

Domain Manager

  • GET /api/v1/machine/domain-manager/dns-records
  • POST /api/v1/machine/domain-manager/dns-records
  • GET /api/v1/machine/domain-manager/domain-tenants
  • GET /api/v1/machine/domain-manager/search-domains
  • POST /api/v1/machine/domain-manager/:id/make-default
  • POST /api/v1/machine/domain-manager/create-domain-tenant
  • PATCH /api/v1/machine/domain-manager/:id/archive
  • POST /api/v1/machine/domain-manager/purchase-domain
  • PATCH /api/v1/machine/domain-manager/dns-records/delete
  • PATCH /api/v1/machine/domain-manager/dns-records/edit
  • POST /api/v1/machine/domain-manager/enable-email-forwarding
  • GET /api/v1/machine/domain-manager/email-forwarding-status
  • POST /api/v1/machine/domain-manager/disable-email-forwarding
  • POST /api/v1/machine/domain-manager/verify-email-forwarding
  • GET /api/v1/machine/domain-manager/email-routes
  • POST /api/v1/machine/domain-manager/email-routes
  • DELETE /api/v1/machine/domain-manager/email-routes
  • GET /api/v1/machine/domain-manager/ssl-certificates
  • POST /api/v1/machine/domain-manager/ssl-certificates/letsencrypt
  • POST /api/v1/machine/domain-manager/ssl-certificates/finalize
  • POST /api/v1/machine/domain-manager/ssl-certificates/check-status
  • POST /api/v1/machine/domain-manager/ssl-certificates/upload
  • POST /api/v1/machine/domain-manager/ssl-certificates/:id/check-status
  • GET /api/v1/machine/domain-manager/ssl-certificates/:id/files
  • DELETE /api/v1/machine/domain-manager/ssl-certificates/:id

Admin and Operations

Integration

  • GET /api/v1/machine/integration/integrations
  • GET /api/v1/machine/integration/integration-instances
  • GET /api/v1/machine/integration/integration-instance/:integrationInstanceId/detail
  • POST /api/v1/machine/integration/:id/force-sync-integration-service
  • POST /api/v1/machine/integration/:id/create-integration-instance
  • PATCH /api/v1/machine/integration/:id/archive-integration-instance
  • POST /api/v1/machine/integration/test
  • GET /api/v1/machine/integration/:domainTenantId/:integrationId/:functionId/authorization-url
  • GET /api/v1/machine/integration/:domainTenantId/:integrationId/integration-config
  • POST /api/v1/machine/integration/integration-request

Intelligence Provider

  • GET /api/v1/machine/intelligence-provider/list
  • GET /api/v1/machine/intelligence-provider/metadata
  • POST /api/v1/machine/intelligence-provider/create
  • GET /api/v1/machine/intelligence-provider/:id
  • GET /api/v1/machine/intelligence-provider/:id/runtime
  • POST /api/v1/machine/intelligence-provider/:id/authorize-usage
  • POST /api/v1/machine/intelligence-provider/:id/report-usage
  • PATCH /api/v1/machine/intelligence-provider/:id/archive

User Manager

  • GET /api/v1/machine/user-manager/tenant-users
  • GET /api/v1/machine/user-manager/:id/security-groups-for-tenant
  • PATCH /api/v1/machine/user-manager/:id/archive-org-invitation
  • POST /api/v1/machine/user-manager/add-user-to-tenant
  • POST /api/v1/machine/user-manager/invite-users
  • POST /api/v1/machine/user-manager/remove-member
  • GET /api/v1/machine/user-manager/tenant-invitations
  • PATCH /api/v1/machine/user-manager/archive-org-user
  • PATCH /api/v1/machine/user-manager/update-user-tenant-roles

Tenant Admin

  • GET /api/v1/machine/tenant-admin/:id/security-group-members
  • PATCH /api/v1/machine/tenant-admin/update-security-group-roles
  • PATCH /api/v1/machine/tenant-admin/:id/update-members
  • POST /api/v1/machine/tenant-admin/assign-user-to-tenant
  • PATCH /api/v1/machine/tenant-admin/:id/update-tenant
  • PATCH /api/v1/machine/tenant-admin/change-license-tenant
  • POST /api/v1/machine/tenant-admin/create-api-key
  • GET /api/v1/machine/tenant-admin/api-keys
  • POST /api/v1/machine/tenant-admin/api-key/:id/archive
  • PATCH /api/v1/machine/tenant-admin/api-key/:id/vault-item
  • POST /api/v1/machine/tenant-admin/:id/archive
  • POST /api/v1/machine/tenant-admin/:id/make-default
  • POST /api/v1/machine/tenant-admin/update
  • DELETE /api/v1/machine/tenant-admin/:id/delete-security-group
  • POST /api/v1/machine/tenant-admin/create-security-group
  • POST /api/v1/machine/tenant-admin/add-security-member
  • GET /api/v1/machine/tenant-admin/:id/security-group-agents
  • PATCH /api/v1/machine/tenant-admin/:id/update-agents

Org Admin

  • GET /api/v1/machine/org-admin/org-tenants
  • POST /api/v1/machine/org-admin/change-org-user-primary-tenant
  • POST /api/v1/machine/org-admin/create-tenant
  • POST /api/v1/machine/org-admin/reassign-tenant
  • PATCH /api/v1/machine/org-admin/update-user-roles
  • PATCH /api/v1/machine/org-admin/:id/assign-myself-to-tenant
  • PATCH /api/v1/machine/org-admin/:id/unlink-tenant
  • PATCH /api/v1/machine/org-admin/:id/archive-tenant
  • GET /api/v1/machine/org-admin/org-admin-users
  • PATCH /api/v1/machine/org-admin/update-org-settings
  • GET /api/v1/machine/org-admin/org-api-keys
  • POST /api/v1/machine/org-admin/create-org-api-key
  • POST /api/v1/machine/org-admin/:id/archive-org-api-key

License Manager

  • POST /api/v1/machine/license-manager/create-manual-license
  • GET /api/v1/machine/license-manager/:licenseId/license-vault-item
  • GET /api/v1/machine/license-manager/:id/activity-manager
  • POST /api/v1/machine/license-manager/update-managed-license
  • POST /api/v1/machine/license-manager/update-manual-license
  • POST /api/v1/machine/license-manager/attach-license-asset
  • GET /api/v1/machine/license-manager/:licenseId/assets
  • POST /api/v1/machine/license-manager/archive
  • POST /api/v1/machine/license-manager/archive-group
  • GET /api/v1/machine/license-manager/licenses
  • GET /api/v1/machine/license-manager/:groupId/license-group
  • GET /api/v1/machine/license-manager/:licenseId/license
  • POST /api/v1/machine/license-manager/associate-license-with-contract

Contract Manager

  • GET /api/v1/machine/contract-manager/product-provider-options
  • POST /api/v1/machine/contract-manager/create-contract
  • POST /api/v1/machine/contract-manager/attach-contract-asset
  • GET /api/v1/machine/contract-manager/:contractId/assets
  • POST /api/v1/machine/contract-manager/archive
  • GET /api/v1/machine/contract-manager/contracts
  • POST /api/v1/machine/contract-manager/:contractId/update
  • GET /api/v1/machine/contract-manager/:contractId/contract
  • GET /api/v1/machine/contract-manager/:contractId/licenses

Order Manager

  • GET /api/v1/machine/order-manager/orders-for-approval
  • GET /api/v1/machine/order-manager/orders
  • PATCH /api/v1/machine/order-manager/:id/approve
  • PATCH /api/v1/machine/order-manager/:id/reject

Product

  • GET /api/v1/machine/product/tenant-product-instances
  • GET /api/v1/machine/product/:id/product-instance-detail
  • PATCH /api/v1/machine/product/:id/archive-product-instance

Monitoring

  • GET /api/v1/machine/monitoring/system-stats
  • GET /api/v1/machine/monitoring/session-stats
  • GET /api/v1/machine/monitoring/entity-counts
  • GET /api/v1/machine/monitoring/metric-stats
  • GET /api/v1/machine/monitoring/request-events
  • GET /api/v1/machine/monitoring/audit-events
  • GET /api/v1/machine/monitoring/vault-activity-events

Billing

  • POST /api/v1/machine/billing/setup-intent
  • GET /api/v1/machine/billing/payment-methods
  • POST /api/v1/machine/billing/payment-methods/attach
  • POST /api/v1/machine/billing/add-credit
  • GET /api/v1/machine/billing/billing-data
  • GET /api/v1/machine/billing/balance
  • GET /api/v1/machine/billing/credit-transactions
  • POST /api/v1/machine/billing/crypto-funding-intents
  • GET /api/v1/machine/billing/crypto-funding-intents
  • GET /api/v1/machine/billing/crypto-funding-intents/:id
  • POST /api/v1/machine/billing/payment-methods/:id/set-default
  • DELETE /api/v1/machine/billing/payment-methods/:id
  • GET /api/v1/machine/billing/readiness