{"openapi":"3.1.0","info":{"title":"bind","description":"Request Bins: a bin is a public URL that answers any HTTP request at once and records it (method, path, query, headers, body and source address) for the workspace that created it (RFC-0026).","version":"0.1.20"},"paths":{"/v1/plan":{"get":{"tags":["account"],"summary":"Read Plan","operationId":"read_plan_v1_plan_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/usage":{"get":{"tags":["account"],"summary":"Read Usage","operationId":"read_usage_v1_usage_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/bins":{"post":{"tags":["bins"],"summary":"Create Bin","description":"Create a bin. Its URL is answered and recorded at once.","operationId":"create_bin_v1_bins_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"error.code = quota_exceeded | workspace_frozen | workspace_suspended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","quota_exceeded","unauthorized","validation_error","workspace_frozen","workspace_suspended"]},"get":{"tags":["bins"],"summary":"List Bins","description":"The workspace's bins, newest first. ``url`` or ``slug`` returns at most one, or none.","operationId":"list_bins_v1_bins_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}},{"name":"url","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}],"description":"Only the bin this public URL names.","title":"Url"},"description":"Only the bin this public URL names."},{"name":"slug","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"description":"Only the bin with this slug.","title":"Slug"},"description":"Only the bin with this slug."},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_BinOut_"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/bins/{bin_id}":{"get":{"tags":["bins"],"summary":"Read Bin","operationId":"read_bin_v1_bins__bin_id__get","parameters":[{"name":"bin_id","in":"path","required":true,"schema":{"type":"string","title":"Bin Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]},"patch":{"tags":["bins"],"summary":"Patch Bin","description":"Rename a bin, switch it off (``disabled``: it answers and records nothing) and on\n(``enabled``), or set its ``forward_url`` (RFC-0027): every request it then records is also\nsent on to that URL, and the request's detail shows what the server answered.\n\n``forward_pipeline`` (RFC-0030) runs on every forward before it is sent: header and auth steps\n(a credential from a secret, for a target that authenticates its caller), filters, and, with\n``forward_pipeline_changes_body``, steps that rewrite the body. Checked whole when it is saved:\na 422 ``invalid_pipeline`` names the first problem's step, path and reason. Deciding where a\nsecret goes is an owner's or admin's (403 ``role``): saving a pipeline whose auth step names\none, and moving the URL of a bin whose pipeline does.\n\n``active``, the earlier word for ``enabled``, is still accepted for ``status`` and is\ndeprecated: the bin comes back ``enabled``, and the changelog will announce the date ``active``\nis refused from.","operationId":"patch_bin_v1_bins__bin_id__patch","parameters":[{"name":"bin_id","in":"path","required":true,"schema":{"type":"string","title":"Bin Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinPatch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"error.code = not_entitled | workspace_frozen | workspace_suspended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"error.code = unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_entitled","not_found","payload_too_large","unauthorized","unavailable","validation_error","workspace_frozen","workspace_suspended"]},"delete":{"tags":["bins"],"summary":"Delete Bin","description":"Delete a bin: its URL stops recording at once, its slug is never issued again, and its\ncaptured requests are removed shortly after.","operationId":"delete_bin_v1_bins__bin_id__delete","parameters":[{"name":"bin_id","in":"path","required":true,"schema":{"type":"string","title":"Bin Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"204":{"description":"Successful Response"},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/pipeline-templates":{"get":{"tags":["bins"],"summary":"List Pipeline Templates","description":"transform-core's gallery (RFC-0030): ready-made forward pipelines to start one from. A\nSlack, Discord or Microsoft Teams message (a request a bin captured is shown whole), and the\nbody with only the fields listed or without its personal data. Each changes the body, so saving\none needs ``forward_pipeline_changes_body``. The same for every workspace; saving one makes a\ncopy that is the bin's own.","operationId":"list_pipeline_templates_v1_pipeline_templates_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PipelineTemplateOut"},"title":"Response List Pipeline Templates V1 Pipeline Templates Get"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/bins/{bin_id}/forward-pipeline/test":{"post":{"tags":["bins"],"summary":"Test Forward Pipeline","description":"Run a forward pipeline once on one of the bin's requests and send nothing: the editor's\nTest. ``pipeline`` need not be saved (omitted, the bin's own runs); it is checked as a save\nchecks it, but a step that changes the body needs no confirmation here. Its auth steps add the\nworkspace's secrets, shown masked (``Bearer ••••``). The answer is what a forward would send,\nRequest Bins' own headers included, or which step dropped or failed it.","operationId":"test_forward_pipeline_v1_bins__bin_id__forward_pipeline_test_post","parameters":[{"name":"bin_id","in":"path","required":true,"schema":{"type":"string","title":"Bin Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineTestIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineTestOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"error.code = not_entitled | workspace_frozen | workspace_suspended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"error.code = unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_entitled","not_found","payload_too_large","unauthorized","unavailable","validation_error","workspace_frozen","workspace_suspended"]}},"/v1/bins/{bin_id}/forward-test":{"post":{"tags":["bins"],"summary":"Test Forward","description":"Send a small JSON event (``{\"type\": \"request_bins.forward_test\", …}``) to the bin's forward\nURL now and return what it answered, so the URL is checked before real traffic depends on it.\nA few a minute per bin. The forwarder sends it, as it sends every forward: 503\n``forwarder_unavailable`` means it did not take the test within a few seconds, so nothing was\nsent. The bin's forward pipeline runs on the event first, as on every forward (RFC-0030), so the\ntest also checks the credential its auth step adds; ``pipeline`` shows what it sent, masked.","operationId":"test_forward_v1_bins__bin_id__forward_test_post","parameters":[{"name":"bin_id","in":"path","required":true,"schema":{"type":"string","title":"Bin Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForwardTestOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"error.code = not_entitled | workspace_frozen | workspace_suspended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"error.code = rate_limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"error.code = unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_entitled","not_found","payload_too_large","rate_limited","unauthorized","unavailable","validation_error","workspace_frozen","workspace_suspended"]}},"/v1/bins/{bin_id}/requests":{"get":{"tags":["requests"],"summary":"List Requests","description":"A bin's captured requests, newest first. Poll with ``since`` set to the newest\n``received_at`` already seen; walk back with ``until``. A search (``q``, or a ``header`` or\n``field``) continues with ``until`` set to the page's ``next_until``; its ``offset`` skips\nrequests before it reads.","operationId":"list_requests_v1_bins__bin_id__requests_get","parameters":[{"name":"bin_id","in":"path","required":true,"schema":{"type":"string","title":"Bin Id"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only requests received after this instant (strict).","title":"Since"},"description":"Only requests received after this instant (strict)."},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only requests received at or before this instant.","title":"Until"},"description":"Only requests received at or before this instant."},{"name":"method","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","pattern":"^[!#$%&'*+.^_`|~0-9A-Za-z-]{1,16}$"},"maxItems":16,"description":"Only requests sent with this method; repeat it for any of several. Case-insensitive.","default":[],"title":"Method"},"description":"Only requests sent with this method; repeat it for any of several. Case-insensitive."},{"name":"path","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":2048,"pattern":"^/"},{"type":"null"}],"description":"Only requests sent to exactly this path: what followed the slug, from its `/`, as the list shows it, without the query string. Case-sensitive.","title":"Path"},"description":"Only requests sent to exactly this path: what followed the slug, from its `/`, as the list shows it, without the query string. Case-sensitive."},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Only requests containing this text, ignoring case, in the path and query string, a header (as `name: value`) or the body; `in`, `header` and `field` narrow where. A search reads at most 16 MiB of requests per call, newest first: when it stops before the oldest, `next_until` is set and `next_offset` is not.","title":"Q"},"description":"Only requests containing this text, ignoring case, in the path and query string, a header (as `name: value`) or the body; `in`, `header` and `field` narrow where. A search reads at most 16 MiB of requests per call, newest first: when it stops before the oldest, `next_until` is set and `next_offset` is not."},{"name":"in","in":"query","required":false,"schema":{"enum":["all","path","headers","body"],"type":"string","description":"Where `q` looks: `all`, or only `path` (the path and query string), `headers` (each as `name: value`) or `body`.","default":"all","title":"In"},"description":"Where `q` looks: `all`, or only `path` (the path and query string), `headers` (each as `name: value`) or `body`."},{"name":"header","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[!#$%&'*+.^_`|~0-9A-Za-z-]{1,200}$"},{"type":"null"}],"description":"Only this header's values, its name ignoring case; any of them when it was sent more than once. Without `q`, the requests that carry it at all.","title":"Header"},"description":"Only this header's values, its name ignoring case; any of them when it was sent more than once. Without `q`, the requests that carry it at all."},{"name":"field","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200,"pattern":"^\\s*\\$?(?:\\.?[^.\\[\\]]+|\\[[0-9]{1,9}\\])(?:\\.[^.\\[\\]]+|\\[[0-9]{1,9}\\]){0,31}\\s*$"},{"type":"null"}],"description":"Only this field of a JSON body, as `data.object.id` or `items[0].sku`: a string as itself, a number as JSON writes it, an object or array as JSON text. Without `q`, the requests whose body has it at all. A body that is not JSON, or was cut at 1 MiB, has no fields.","title":"Field"},"description":"Only this field of a JSON body, as `data.object.id` or `items[0].sku`: a string as itself, a number as JSON writes it, an object or array as JSON text. Without `q`, the requests whose body has it at all. A body that is not JSON, or was cut at 1 MiB, has no fields."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPage"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"error.code = not_entitled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_entitled","not_found","payload_too_large","unauthorized","validation_error"]},"delete":{"tags":["requests"],"summary":"Empty Bin","description":"Delete every captured request in a bin. The bin keeps its URL and keeps recording.","operationId":"empty_bin_v1_bins__bin_id__requests_delete","parameters":[{"name":"bin_id","in":"path","required":true,"schema":{"type":"string","title":"Bin Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResult"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/requests":{"get":{"tags":["requests"],"summary":"List All Requests","description":"Every captured request in the workspace's live bins, newest first, each with its\n``bin_id``: what has arrived anywhere, in one call rather than one per bin. It takes the same\nfilters, search and paging as ``GET /v1/bins/{bin_id}/requests``, and the same credentials: any\nseat, and an API key on a plan that includes reading captures.","operationId":"list_all_requests_v1_requests_get","parameters":[{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only requests received after this instant (strict).","title":"Since"},"description":"Only requests received after this instant (strict)."},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only requests received at or before this instant.","title":"Until"},"description":"Only requests received at or before this instant."},{"name":"method","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","pattern":"^[!#$%&'*+.^_`|~0-9A-Za-z-]{1,16}$"},"maxItems":16,"description":"Only requests sent with this method; repeat it for any of several. Case-insensitive.","default":[],"title":"Method"},"description":"Only requests sent with this method; repeat it for any of several. Case-insensitive."},{"name":"path","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":2048,"pattern":"^/"},{"type":"null"}],"description":"Only requests sent to exactly this path: what followed the slug, from its `/`, as the list shows it, without the query string. Case-sensitive.","title":"Path"},"description":"Only requests sent to exactly this path: what followed the slug, from its `/`, as the list shows it, without the query string. Case-sensitive."},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Only requests containing this text, ignoring case, in the path and query string, a header (as `name: value`) or the body; `in`, `header` and `field` narrow where. A search reads at most 16 MiB of requests per call, newest first: when it stops before the oldest, `next_until` is set and `next_offset` is not.","title":"Q"},"description":"Only requests containing this text, ignoring case, in the path and query string, a header (as `name: value`) or the body; `in`, `header` and `field` narrow where. A search reads at most 16 MiB of requests per call, newest first: when it stops before the oldest, `next_until` is set and `next_offset` is not."},{"name":"in","in":"query","required":false,"schema":{"enum":["all","path","headers","body"],"type":"string","description":"Where `q` looks: `all`, or only `path` (the path and query string), `headers` (each as `name: value`) or `body`.","default":"all","title":"In"},"description":"Where `q` looks: `all`, or only `path` (the path and query string), `headers` (each as `name: value`) or `body`."},{"name":"header","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[!#$%&'*+.^_`|~0-9A-Za-z-]{1,200}$"},{"type":"null"}],"description":"Only this header's values, its name ignoring case; any of them when it was sent more than once. Without `q`, the requests that carry it at all.","title":"Header"},"description":"Only this header's values, its name ignoring case; any of them when it was sent more than once. Without `q`, the requests that carry it at all."},{"name":"field","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200,"pattern":"^\\s*\\$?(?:\\.?[^.\\[\\]]+|\\[[0-9]{1,9}\\])(?:\\.[^.\\[\\]]+|\\[[0-9]{1,9}\\]){0,31}\\s*$"},{"type":"null"}],"description":"Only this field of a JSON body, as `data.object.id` or `items[0].sku`: a string as itself, a number as JSON writes it, an object or array as JSON text. Without `q`, the requests whose body has it at all. A body that is not JSON, or was cut at 1 MiB, has no fields.","title":"Field"},"description":"Only this field of a JSON body, as `data.object.id` or `items[0].sku`: a string as itself, a number as JSON writes it, an object or array as JSON text. Without `q`, the requests whose body has it at all. A body that is not JSON, or was cut at 1 MiB, has no fields."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPage"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"error.code = not_entitled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_entitled","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/bins/{bin_id}/paths":{"get":{"tags":["requests"],"summary":"List Paths","description":"A bin's requests grouped by path, the most recently used path first: how many were sent to\neach, with which methods, and when the last came. Only the newest 10,000 requests are counted\n(``capped`` says the bin holds more); list one path's requests with ``path=`` on\n``GET /v1/bins/{bin_id}/requests``.","operationId":"list_paths_v1_bins__bin_id__paths_get","parameters":[{"name":"bin_id","in":"path","required":true,"schema":{"type":"string","title":"Bin Id"}},{"name":"method","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","pattern":"^[!#$%&'*+.^_`|~0-9A-Za-z-]{1,16}$"},"maxItems":16,"description":"Only requests sent with this method; repeat it for any of several. Case-insensitive.","default":[],"title":"Method"},"description":"Only requests sent with this method; repeat it for any of several. Case-insensitive."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PathPage"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"error.code = not_entitled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_entitled","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/requests/{request_id}":{"get":{"tags":["requests"],"summary":"Read Request","description":"One captured request in full: headers in arrival order, the query, the body, and its\nforwards with what the target answered (RFC-0027).","operationId":"read_request_v1_requests__request_id__get","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","title":"Request Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapturedRequestDetailOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"error.code = not_entitled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_entitled","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/secrets":{"post":{"tags":["secrets"],"summary":"Create Secret","description":"Store a credential for a forward pipeline's auth step to add: a bearer token, a password, an\nAPI key. Sealed when it is written and never returned; a pipeline names it by the ``id`` this\nanswers. Wherever forwarding is: Starter, Pro and Custom.","operationId":"create_secret_v1_secrets_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"error.code = not_entitled | workspace_frozen | workspace_suspended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"error.code = unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_entitled","not_found","payload_too_large","unauthorized","unavailable","validation_error","workspace_frozen","workspace_suspended"]},"get":{"tags":["secrets"],"summary":"List Secrets","description":"The workspace's secrets, newest first, by name and id: never a value.","operationId":"list_secrets_v1_secrets_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_SecretOut_"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/secrets/{secret_id}":{"get":{"tags":["secrets"],"summary":"Read Secret","operationId":"read_secret_v1_secrets__secret_id__get","parameters":[{"name":"secret_id","in":"path","required":true,"schema":{"type":"string","title":"Secret Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]},"patch":{"tags":["secrets"],"summary":"Patch Secret","description":"Rename a secret, or replace its value: every forward through a pipeline that names it sends\nthe new one from its next attempt on.","operationId":"patch_secret_v1_secrets__secret_id__patch","parameters":[{"name":"secret_id","in":"path","required":true,"schema":{"type":"string","title":"Secret Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretPatch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"error.code = workspace_frozen | workspace_suspended"},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"error.code = unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","unavailable","validation_error","workspace_frozen","workspace_suspended"]},"delete":{"tags":["secrets"],"summary":"Delete Secret","description":"Delete a secret, for good. Refused (409 ``secret_in_use``) while a bin's forward pipeline\nnames it: change those pipelines first.","operationId":"delete_secret_v1_secrets__secret_id__delete","parameters":[{"name":"secret_id","in":"path","required":true,"schema":{"type":"string","title":"Secret Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"204":{"description":"Successful Response"},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"error.code = conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["conflict","forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}}},"components":{"schemas":{"BinCreate":{"properties":{"label":{"type":"string","maxLength":200,"title":"Label","default":""},"expires_in_minutes":{"anyOf":[{"type":"integer","maximum":525600,"minimum":1},{"type":"null"}],"title":"Expires In Minutes"}},"type":"object","title":"BinCreate"},"BinOut":{"properties":{"id":{"type":"string","title":"Id"},"slug":{"type":"string","title":"Slug"},"url":{"type":"string","title":"Url","default":""},"label":{"type":"string","title":"Label"},"status":{"type":"string","enum":["enabled","disabled"],"title":"Status"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"suspended":{"type":"boolean","title":"Suspended","default":false},"suspended_code":{"type":"string","title":"Suspended Code","default":"","x-known-values":["source_fanout","browser_posts","abuse","non_payment","plan_downgrade"]},"suspended_reason":{"type":"string","title":"Suspended Reason","default":""},"refused_count":{"type":"integer","title":"Refused Count","default":0},"last_refused_summary":{"type":"string","title":"Last Refused Summary","default":""},"last_refused_reason":{"type":"string","title":"Last Refused Reason","default":""},"last_refused_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Refused At"},"browser_post_count":{"type":"integer","title":"Browser Post Count","default":0},"last_browser_form_origin":{"type":"string","title":"Last Browser Form Origin","default":""},"last_browser_form_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Browser Form At"},"request_count":{"type":"integer","title":"Request Count","default":0},"last_request_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Request At"},"period_requests":{"type":"integer","title":"Period Requests","default":0},"forward_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forward Url"},"forward_paused_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Forward Paused At"},"forward_paused_reason":{"type":"string","title":"Forward Paused Reason","default":"","x-known-values":["failed_in_a_row","failing_for_an_hour"]},"forward_last_error":{"type":"string","title":"Forward Last Error","default":""},"forward_last_error_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Forward Last Error At"},"forward_pipeline":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"additionalProperties":true,"title":"Forward Pipeline"},"forward_pipeline_version":{"type":"integer","title":"Forward Pipeline Version","default":0},"forward_pipeline_changes_body":{"type":"boolean","title":"Forward Pipeline Changes Body","default":false},"forward_pipeline_updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Forward Pipeline Updated At"}},"type":"object","required":["id","slug","label","status","expires_at","created_at"],"title":"BinOut"},"BinPatch":{"properties":{"label":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Label"},"status":{"anyOf":[{"type":"string","enum":["enabled","disabled","active"]},{"type":"null"}],"title":"Status","description":"`enabled` records what the bin is sent; `disabled` answers and records nothing. `active` is a deprecated spelling of `enabled`: it is still accepted, the bin comes back `enabled`, and the changelog will announce the date it is refused from."},"forward_url":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}],"title":"Forward Url"},"forward_pipeline":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"additionalProperties":true,"title":"Forward Pipeline"},"forward_pipeline_changes_body":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Forward Pipeline Changes Body"}},"type":"object","title":"BinPatch"},"CapturedRequestDetailOut":{"properties":{"id":{"type":"string","title":"Id"},"bin_id":{"type":"string","title":"Bin Id"},"method":{"type":"string","title":"Method"},"path":{"type":"string","title":"Path"},"query":{"type":"string","title":"Query"},"source_ip":{"type":"string","title":"Source Ip"},"content_type":{"type":"string","title":"Content Type"},"size_bytes":{"type":"integer","title":"Size Bytes"},"truncated":{"type":"boolean","title":"Truncated"},"seen_count":{"type":"integer","title":"Seen Count"},"received_at":{"type":"string","format":"date-time","title":"Received At"},"expires_at":{"type":"string","format":"date-time","title":"Expires At"},"headers":{"items":{"$ref":"#/components/schemas/HeaderOut"},"type":"array","title":"Headers"},"body_base64":{"type":"string","title":"Body Base64"},"request_id":{"type":"string","title":"Request Id"},"forwards":{"items":{"$ref":"#/components/schemas/ForwardOut"},"type":"array","title":"Forwards","default":[]}},"type":"object","required":["id","bin_id","method","path","query","source_ip","content_type","size_bytes","truncated","seen_count","received_at","expires_at","headers","body_base64","request_id"],"title":"CapturedRequestDetailOut"},"CapturedRequestOut":{"properties":{"id":{"type":"string","title":"Id"},"bin_id":{"type":"string","title":"Bin Id"},"method":{"type":"string","title":"Method"},"path":{"type":"string","title":"Path"},"query":{"type":"string","title":"Query"},"source_ip":{"type":"string","title":"Source Ip"},"content_type":{"type":"string","title":"Content Type"},"size_bytes":{"type":"integer","title":"Size Bytes"},"truncated":{"type":"boolean","title":"Truncated"},"seen_count":{"type":"integer","title":"Seen Count"},"received_at":{"type":"string","format":"date-time","title":"Received At"},"expires_at":{"type":"string","format":"date-time","title":"Expires At"}},"type":"object","required":["id","bin_id","method","path","query","source_ip","content_type","size_bytes","truncated","seen_count","received_at","expires_at"],"title":"CapturedRequestOut"},"EmptyResult":{"properties":{"deleted":{"type":"integer","title":"Deleted"}},"type":"object","required":["deleted"],"title":"EmptyResult"},"ErrorDetail":{"description":"The `error` object: what went wrong.","properties":{"code":{"description":"Stable machine-readable reason. Clients branch on this.","title":"Code","type":"string","x-known-values":["bad_envelope","bad_request","conflict","error","forbidden","internal","internal_error","invalid_credential","invalid_pipeline","invalid_request","method_not_allowed","not_entitled","not_found","payload_too_large","plan_violation","quota_exceeded","rate_limited","unauthorized","unavailable","unprocessable","unprocessable_event","validation_error","workspace_frozen","workspace_suspended"]},"message":{"description":"Human-readable explanation. Never branch on it.","title":"Message","type":"string"},"details":{"anyOf":[{},{"type":"null"}],"default":null,"description":"Optional structured detail; its shape is fixed per code, not globally.","title":"Details"},"request_id":{"type":"string","description":"The request's X-Request-ID. Quote it to support; never branch on it."},"next_code":{"type":"string","description":"Present only while this error is moving to a different code: the code it will be sent with once the move is complete. When present, branch on this rather than on `code`.","x-known-values":["bad_envelope","bad_request","conflict","forbidden","internal_error","invalid_credential","invalid_pipeline","method_not_allowed","not_entitled","not_found","payload_too_large","quota_exceeded","rate_limited","unauthorized","unavailable","unprocessable_event","validation_error","workspace_frozen","workspace_suspended"]}},"required":["code","message"],"title":"ErrorDetail","type":"object"},"ErrorEnvelope":{"description":"The body of every error response: an `error` object that says what went wrong.","properties":{"error":{"$ref":"#/components/schemas/ErrorDetail"}},"required":["error"],"title":"ErrorEnvelope","type":"object"},"ForwardAnswerOut":{"properties":{"status":{"type":"integer","title":"Status"},"headers":{"items":{"$ref":"#/components/schemas/HeaderOut"},"type":"array","title":"Headers"},"body_base64":{"type":"string","title":"Body Base64"},"truncated":{"type":"boolean","title":"Truncated"}},"type":"object","required":["status","headers","body_base64","truncated"],"title":"ForwardAnswerOut","description":"What the target answered: its status and headers, and the start of its body."},"ForwardOut":{"properties":{"id":{"type":"string","title":"Id"},"state":{"type":"string","enum":["queued","sending","sent","retrying","failed","not_forwarded"],"title":"State"},"reason":{"type":"string","title":"Reason","default":"","x-known-values":["paused","body_too_large","url_too_long","queue_full","forwarding_off","bin_gone","suspended","not_entitled","request_gone","filtered"]},"url":{"type":"string","title":"Url"},"attempts":{"type":"integer","title":"Attempts"},"max_attempts":{"type":"integer","title":"Max Attempts"},"next_attempt_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Attempt At"},"last_error":{"type":"string","title":"Last Error","default":""},"answer":{"anyOf":[{"$ref":"#/components/schemas/ForwardAnswerOut"},{"type":"null"}]},"duration_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration Ms"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"sent_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Sent At"},"pipeline":{"anyOf":[{"$ref":"#/components/schemas/ForwardPipelineOut"},{"type":"null"}]}},"type":"object","required":["id","state","url","attempts","max_attempts","created_at"],"title":"ForwardOut","description":"One send of a captured request to its bin's forward URL (RFC-0027)."},"ForwardPipelineOut":{"properties":{"version":{"type":"integer","title":"Version"},"step":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Step"},"body_changed":{"type":"boolean","title":"Body Changed","default":false},"headers":{"items":{"$ref":"#/components/schemas/HeaderOut"},"type":"array","title":"Headers","default":[]},"credential_query":{"items":{"type":"string"},"type":"array","title":"Credential Query","default":[]}},"type":"object","required":["version"],"title":"ForwardPipelineOut","description":"What the bin's forward pipeline did (RFC-0030 X10), on a forward's last attempt or a test."},"ForwardTestOut":{"properties":{"ok":{"type":"boolean","title":"Ok"},"answer":{"anyOf":[{"$ref":"#/components/schemas/ForwardAnswerOut"},{"type":"null"}]},"duration_ms":{"type":"integer","title":"Duration Ms"},"error":{"type":"string","title":"Error","default":""},"pipeline":{"anyOf":[{"$ref":"#/components/schemas/ForwardPipelineOut"},{"type":"null"}]}},"type":"object","required":["ok","duration_ms"],"title":"ForwardTestOut","description":"What a test send to the bin's forward URL got back."},"HeaderOut":{"properties":{"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"}},"type":"object","required":["name","value"],"title":"HeaderOut"},"Page_BinOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BinOut"},"type":"array","title":"Items"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["items"],"title":"Page[BinOut]"},"Page_SecretOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/SecretOut"},"type":"array","title":"Items"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["items"],"title":"Page[SecretOut]"},"PathGroupOut":{"properties":{"path":{"type":"string","title":"Path"},"requests":{"type":"integer","title":"Requests"},"methods":{"items":{"type":"string"},"type":"array","title":"Methods"},"last_received_at":{"type":"string","format":"date-time","title":"Last Received At"}},"type":"object","required":["path","requests","methods","last_received_at"],"title":"PathGroupOut"},"PathPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PathGroupOut"},"type":"array","title":"Items"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"counted":{"type":"integer","title":"Counted"},"capped":{"type":"boolean","title":"Capped"}},"type":"object","required":["items","counted","capped"],"title":"PathPage","description":"A bin's paths, the most recently used first, among its newest requests."},"PipelineTemplateOut":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"pipeline":{"additionalProperties":true,"type":"object","title":"Pipeline"},"changes_body":{"type":"boolean","title":"Changes Body"}},"type":"object","required":["id","name","description","pipeline","changes_body"],"title":"PipelineTemplateOut","description":"A ready-made pipeline from transform-core's gallery: a starting point. Saving one makes a\ncopy that is the bin's own; nothing refers back to the template."},"PipelineTestIn":{"properties":{"pipeline":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"additionalProperties":true,"title":"Pipeline"},"request_id":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Request Id"}},"type":"object","title":"PipelineTestIn","description":"Run a forward pipeline once on one of the bin's requests and send nothing: the console's\nTest. It need not be saved, so it tests what is in the editor."},"PipelineTestOut":{"properties":{"status":{"type":"string","enum":["ok","dropped","failed"],"title":"Status"},"request_id":{"type":"string","title":"Request Id"},"step":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Step"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"error":{"type":"string","title":"Error","default":""},"method":{"type":"string","title":"Method"},"headers":{"items":{"$ref":"#/components/schemas/HeaderOut"},"type":"array","title":"Headers","default":[]},"credential_query":{"items":{"type":"string"},"type":"array","title":"Credential Query","default":[]},"body_base64":{"type":"string","title":"Body Base64","default":""},"body_changed":{"type":"boolean","title":"Body Changed","default":false},"duration_ms":{"type":"number","title":"Duration Ms","default":0}},"type":"object","required":["status","request_id","method"],"title":"PipelineTestOut","description":"What a forward of that request would do: send `body_base64` with `headers`, send nothing (a\nfilter dropped it), or fail (`pipeline_failed`)."},"PlanOut":{"properties":{"plan":{"type":"string","title":"Plan"},"enforced_as":{"type":"string","title":"Enforced As"},"ceilings":{"additionalProperties":{"type":"integer"},"type":"object","title":"Ceilings"},"past_due":{"type":"boolean","title":"Past Due","default":false},"suspended":{"type":"boolean","title":"Suspended","default":false},"system":{"type":"boolean","title":"System","default":false}},"type":"object","required":["plan","enforced_as","ceilings"],"title":"PlanOut"},"RequestPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CapturedRequestOut"},"type":"array","title":"Items"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"next_until":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Until"}},"type":"object","required":["items"],"title":"RequestPage","description":"A bin's requests, or the workspace's across its bins. A search (`q`) pages by `next_until`,\nnever by `next_offset`."},"SecretIn":{"properties":{"name":{"type":"string","maxLength":200,"title":"Name","default":""},"value":{"type":"string","maxLength":4096,"minLength":1,"pattern":"^[\\x21-\\x7E](?:[\\x20-\\x7E]*[\\x21-\\x7E])?$","title":"Value","writeOnly":true}},"type":"object","required":["value"],"title":"SecretIn"},"SecretOut":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"bin_count":{"type":"integer","title":"Bin Count","default":0},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","created_at","updated_at"],"title":"SecretOut","description":"A secret of the workspace, by name and id: never its value."},"SecretPatch":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Name"},"value":{"anyOf":[{"type":"string","maxLength":4096,"minLength":1,"pattern":"^[\\x21-\\x7E](?:[\\x20-\\x7E]*[\\x21-\\x7E])?$"},{"type":"null"}],"title":"Value","writeOnly":true}},"type":"object","title":"SecretPatch","description":"Rename it, or replace its value, which every forward sends from its next attempt on."},"UsageOut":{"properties":{"period":{"type":"string","title":"Period"},"requests":{"type":"integer","title":"Requests"},"monthly_requests":{"type":"integer","title":"Monthly Requests"},"purchased_requests":{"type":"integer","title":"Purchased Requests","default":0},"credit":{"anyOf":[{"type":"string","enum":["off","empty","pending"]},{"type":"null"}],"title":"Credit"},"bins":{"type":"integer","title":"Bins"},"max_bins":{"type":"integer","title":"Max Bins"},"bin_request_ceiling":{"type":"integer","title":"Bin Request Ceiling"}},"type":"object","required":["period","requests","monthly_requests","bins","max_bins","bin_request_ceiling"],"title":"UsageOut"}}},"x-error-codes":{"aliases":{"internal":{"code":"internal_error","reason":null},"invalid_request":{"code":"validation_error","reason":null},"unprocessable":{"code":"validation_error","reason":null}},"client_only":["bad_response","gateway_error","network_error","timeout"],"codes":{"bad_envelope":{"audience":"machine","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[400],"umbrella":false},"bad_request":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[400],"umbrella":false},"conflict":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null},"hostname":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"slug":{"format":"identifier","join":null,"kind":"value","required":false,"values":null}},"reasons":{"secret_in_use":{"bins":{"format":"number","join":null,"kind":"value","required":true,"values":null},"id":{"format":"identifier","join":null,"kind":"value","required":true,"values":null}}},"replaced_by":null,"status":[409],"umbrella":true},"error":{"audience":"customer","complete":false,"count_param":null,"deprecated":true,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":null,"replaced_by":null,"status":[],"umbrella":false},"forbidden":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"required":{"format":null,"join":null,"kind":"selector","required":false,"values":["admin","member"]}},"reasons":{"csrf":{},"membership":{},"no_workspace":{},"not_provisioned":{},"operator":{},"product_not_enabled":{},"project":{},"project_confined":{},"role":{},"scope":{}},"replaced_by":null,"status":[403],"umbrella":true},"internal":{"audience":"customer","complete":false,"count_param":null,"deprecated":true,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":null,"replaced_by":"internal_error","status":[500],"umbrella":false},"internal_error":{"audience":"customer","complete":true,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[500],"umbrella":false},"invalid_credential":{"audience":"customer","complete":true,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[401,403],"umbrella":false},"invalid_pipeline":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{"auth_not_last":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"changes_body":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"credential_header":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"forbidden_header":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_document":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_filter":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_header":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_path":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_secret":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_step":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_template":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_value":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"managed_header":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"no_steps":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"not_json":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"too_deep":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"too_large":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"too_many_steps":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"unknown_secret":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"unknown_step":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"unsupported_version":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}}},"replaced_by":null,"status":[422],"umbrella":false},"invalid_request":{"audience":"customer","complete":false,"count_param":null,"deprecated":true,"diagnostic_reasons":[],"entry_types":{"bool_parsing":{},"bool_type":{},"date_parsing":{},"date_type":{},"datetime_from_date_parsing":{},"datetime_parsing":{},"datetime_type":{},"dict_type":{},"enum":{},"extra_forbidden":{},"finite_number":{},"float_parsing":{},"float_type":{},"greater_than":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"greater_than_equal":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"int_from_float":{},"int_parsing":{},"int_parsing_size":{},"int_type":{},"json_invalid":{},"json_type":{},"less_than":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"less_than_equal":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"list_type":{},"literal_error":{},"missing":{},"model_attributes_type":{},"model_type":{},"string_pattern_mismatch":{},"string_too_long":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"string_too_short":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"string_type":{},"string_unicode":{},"too_long":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"too_short":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"url_parsing":{},"url_type":{},"uuid_parsing":{},"uuid_type":{}},"params":{},"reasons":null,"replaced_by":"validation_error","status":[422],"umbrella":false},"method_not_allowed":{"audience":"customer","complete":true,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[405],"umbrella":false},"not_entitled":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"feature":{"format":null,"join":null,"kind":"selector","required":false,"values":["forwarding","read_api"]}},"reasons":{},"replaced_by":null,"status":[402],"umbrella":false},"not_found":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"id":{"format":"identifier","join":null,"kind":"value","required":false,"values":null}},"reasons":{"bin":{},"request":{},"secret":{}},"replaced_by":null,"status":[404],"umbrella":true},"payload_too_large":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"limit":{"format":"bytes","join":null,"kind":"value","required":true,"values":null},"size":{"format":"bytes","join":null,"kind":"value","required":false,"values":null}},"reasons":{},"replaced_by":null,"status":[413],"umbrella":false},"plan_violation":{"audience":"customer","complete":false,"count_param":null,"deprecated":true,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":null,"replaced_by":null,"status":[402],"umbrella":false},"quota_exceeded":{"audience":"customer","complete":false,"count_param":"limit","deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"current":{"format":"number","join":null,"kind":"value","required":false,"values":null},"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null},"metric":{"format":null,"join":null,"kind":"selector","required":false,"values":["bins"]},"period":{"format":null,"join":null,"kind":"value","required":false,"values":null}},"reasons":{"allocation":{},"period":{"credit":{"format":null,"join":null,"kind":"selector","required":false,"values":["empty","off","pending"]}}},"replaced_by":null,"status":[402],"umbrella":false},"rate_limited":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"retry_after":{"format":"seconds","join":null,"kind":"value","required":false,"values":null}},"reasons":{},"replaced_by":null,"status":[429],"umbrella":false},"unauthorized":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{"expired":{},"invalid":{},"missing":{},"no_workspace":{},"revoked":{}},"replaced_by":null,"status":[401],"umbrella":true},"unavailable":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"retry_after":{"format":"seconds","join":null,"kind":"value","required":false,"values":null}},"reasons":{"forwarder_unavailable":{},"forwarding_disabled":{},"ingest_disabled":{},"plan_service":{},"secrets_unavailable":{}},"replaced_by":null,"status":[503],"umbrella":false},"unprocessable":{"audience":"customer","complete":false,"count_param":null,"deprecated":true,"diagnostic_reasons":[],"entry_types":{"bool_parsing":{},"bool_type":{},"date_parsing":{},"date_type":{},"datetime_from_date_parsing":{},"datetime_parsing":{},"datetime_type":{},"dict_type":{},"enum":{},"extra_forbidden":{},"finite_number":{},"float_parsing":{},"float_type":{},"greater_than":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"greater_than_equal":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"int_from_float":{},"int_parsing":{},"int_parsing_size":{},"int_type":{},"json_invalid":{},"json_type":{},"less_than":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"less_than_equal":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"list_type":{},"literal_error":{},"missing":{},"model_attributes_type":{},"model_type":{},"string_pattern_mismatch":{},"string_too_long":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"string_too_short":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"string_type":{},"string_unicode":{},"too_long":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"too_short":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"url_parsing":{},"url_type":{},"uuid_parsing":{},"uuid_type":{}},"params":{},"reasons":null,"replaced_by":"validation_error","status":[422],"umbrella":false},"unprocessable_event":{"audience":"machine","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[422],"umbrella":false},"validation_error":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{"bins.forward_target":{"reason":{"format":null,"join":null,"kind":"selector","required":false,"values":["credentials","host","length","missing","not_public","own_domain","port","scheme"]}},"bins.nul_character":{},"bins.search_conflict":{},"bool_parsing":{},"bool_type":{},"date_parsing":{},"date_type":{},"datetime_from_date_parsing":{},"datetime_parsing":{},"datetime_type":{},"dict_type":{},"enum":{},"extra_forbidden":{},"finite_number":{},"float_parsing":{},"float_type":{},"greater_than":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"greater_than_equal":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"int_from_float":{},"int_parsing":{},"int_parsing_size":{},"int_type":{},"json_invalid":{},"json_type":{},"less_than":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"less_than_equal":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"list_type":{},"literal_error":{},"missing":{},"model_attributes_type":{},"model_type":{},"string_pattern_mismatch":{},"string_too_long":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"string_too_short":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"string_type":{},"string_unicode":{},"too_long":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"too_short":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"url_parsing":{},"url_type":{},"uuid_parsing":{},"uuid_type":{}},"params":{},"reasons":{},"replaced_by":null,"status":[422],"umbrella":true},"workspace_frozen":{"audience":"customer","complete":true,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[402],"umbrella":false},"workspace_suspended":{"audience":"customer","complete":true,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[402],"umbrella":false}},"status_codes":{"400":"bad_request","401":"unauthorized","403":"forbidden","404":"not_found","405":"method_not_allowed","409":"conflict","413":"payload_too_large","422":"validation_error","429":"rate_limited","500":"internal_error","503":"unavailable"},"version":1},"servers":[{"url":"https://bins.nimbusnexus.net"}]}