Targets
Endpoints, docs pages, and CLI commands that feedback can be attached to
/api/v0/targetsList targets
Retrieve all targets in your organization, most recently created first.
Which page to return. Starts at 1.
How many results to return per page.
Filter the results to targets of this type.
The targets in this organization.
A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.
What kind of thing feedback is attached to. A target is identified by its type and its metadata together, so the type cannot change once the target exists. Create a new target instead.
A human-readable label for the target.
The details identifying the target. Which fields it carries depends on type; the shape for each type is listed below. Two targets of the same type with the same metadata are the same target.
One of the following:
Rest Endpoint Metadata
The HTTP method (e.g. GET, POST).
The API endpoint path.
The hostname of the API (e.g. api.example.com).
The API version string (e.g. v1).
Documentation Metadata
The URL of the documentation page.
The section heading within the page.
The documentation version string.
Cli Command Metadata
The CLI command name.
The subcommand path, which may be multi-word (e.g. "container run").
The CLI version string.
The documented flags and args, e.g. ["--rm", "--network"].
The number of feedback items attached to this target.
The all-time thumbs-up count.
The all-time thumbs-down count.
reaction_up minus reaction_down.
The ISO 8601 timestamp when the target was created.
The ISO 8601 timestamp when the target was last modified.
The response metadata for a collection.
The page this response came from. Starts at 1.
The number of items per page.
The total number of items across all pages.
The total number of pages.
The path to the next page, carrying the same filters, or null when you are on the last page. Request it as-is rather than building your own query string.
The path to the previous page, carrying the same filters, or null on page 1.
The links for the collection itself, carrying the filters and page from this request.
Where to call this resource in this API, for example /api/v0/feedback/8x7k2mN.
The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.
Where a person can open this resource in InputBuffer, for example /o/yoyodyne/feedback/8x7k2mN. Use it to link a user straight to the page. web is null when the resource has no page of its own.
The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.
The links for each item in data, keyed by that item's id.
401The API token is missing, malformed, or revoked.
The API token is missing, malformed, or revoked.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
500Something went wrong on our end.
Something went wrong on our end.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
/api/v0/targetsCreate a target
Create a target. Targets deduplicate on type plus metadata, so creating one that already exists returns 409 rather than a second copy.
A human-readable label for the target.
The HTTP method (e.g. GET, POST).
The API endpoint path.
The hostname of the API (e.g. api.example.com).
The API version string (e.g. v1).
The single representation of a target. Every target endpoint (list, get, create, and update) returns all of these keys.
A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.
What kind of thing feedback is attached to. A target is identified by its type and its metadata together, so the type cannot change once the target exists. Create a new target instead.
A human-readable label for the target.
The details identifying the target. Which fields it carries depends on type; the shape for each type is listed below. Two targets of the same type with the same metadata are the same target.
One of the following:
Rest Endpoint Metadata
The HTTP method (e.g. GET, POST).
The API endpoint path.
The hostname of the API (e.g. api.example.com).
The API version string (e.g. v1).
Documentation Metadata
The URL of the documentation page.
The section heading within the page.
The documentation version string.
Cli Command Metadata
The CLI command name.
The subcommand path, which may be multi-word (e.g. "container run").
The CLI version string.
The documented flags and args, e.g. ["--rm", "--network"].
The number of feedback items attached to this target.
The all-time thumbs-up count.
The all-time thumbs-down count.
reaction_up minus reaction_down.
The ISO 8601 timestamp when the target was created.
The ISO 8601 timestamp when the target was last modified.
The response metadata for a single resource.
The links for the resource in data.
Where to call this resource in this API, for example /api/v0/feedback/8x7k2mN.
The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.
Where a person can open this resource in InputBuffer, for example /o/yoyodyne/feedback/8x7k2mN. Use it to link a user straight to the page. web is null when the resource has no page of its own.
The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.
The links for the objects embedded in this resource, keyed by the field each one sits at. A value is null when the embedded object has nothing to link to. {} when the resource embeds nothing.
401The API token is missing, malformed, or revoked.
The API token is missing, malformed, or revoked.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
403The token is valid but not permitted to perform this action.
The token is valid but not permitted to perform this action.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
409A target with this type and metadata already exists (conflict).
A target with this type and metadata already exists (conflict).
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
415The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.
The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
422A required field is missing or a field value is invalid. Check field.
A required field is missing or a field value is invalid. Check field.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
500Something went wrong on our end.
Something went wrong on our end.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
/api/v0/targets/{target_id}Get a target
Retrieve a single target by ID.
A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.
The single representation of a target. Every target endpoint (list, get, create, and update) returns all of these keys.
A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.
What kind of thing feedback is attached to. A target is identified by its type and its metadata together, so the type cannot change once the target exists. Create a new target instead.
A human-readable label for the target.
The details identifying the target. Which fields it carries depends on type; the shape for each type is listed below. Two targets of the same type with the same metadata are the same target.
One of the following:
Rest Endpoint Metadata
The HTTP method (e.g. GET, POST).
The API endpoint path.
The hostname of the API (e.g. api.example.com).
The API version string (e.g. v1).
Documentation Metadata
The URL of the documentation page.
The section heading within the page.
The documentation version string.
Cli Command Metadata
The CLI command name.
The subcommand path, which may be multi-word (e.g. "container run").
The CLI version string.
The documented flags and args, e.g. ["--rm", "--network"].
The number of feedback items attached to this target.
The all-time thumbs-up count.
The all-time thumbs-down count.
reaction_up minus reaction_down.
The ISO 8601 timestamp when the target was created.
The ISO 8601 timestamp when the target was last modified.
The response metadata for a single resource.
The links for the resource in data.
Where to call this resource in this API, for example /api/v0/feedback/8x7k2mN.
The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.
Where a person can open this resource in InputBuffer, for example /o/yoyodyne/feedback/8x7k2mN. Use it to link a user straight to the page. web is null when the resource has no page of its own.
The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.
The links for the objects embedded in this resource, keyed by the field each one sits at. A value is null when the embedded object has nothing to link to. {} when the resource embeds nothing.
401The API token is missing, malformed, or revoked.
The API token is missing, malformed, or revoked.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
403The token is valid but not permitted to perform this action.
The token is valid but not permitted to perform this action.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
404No target matches this ID in your organization (target-not-found).
No target matches this ID in your organization (target-not-found).
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
500Something went wrong on our end.
Something went wrong on our end.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
/api/v0/targets/{target_id}Update a target
Partially update a target using RFC 7396 JSON Merge Patch. Omit a field to leave it unchanged. metadata merges key-by-key rather than replacing, so you can change one key without restating the rest. type cannot be changed after creation.
A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.
A human-readable label for the target.
Merged into the stored metadata key-by-key rather than replacing it, so a patch of {"path": "/v2"} on a REST endpoint leaves method intact. A null *inside* the object removes that key; if the result no longer satisfies the shape for the target's existing type, the request is a 422. Changing type itself is not possible. Because a target is identified by its type and metadata, a patch that makes this target identical to another one in your organization is a 409.
The single representation of a target. Every target endpoint (list, get, create, and update) returns all of these keys.
A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.
What kind of thing feedback is attached to. A target is identified by its type and its metadata together, so the type cannot change once the target exists. Create a new target instead.
A human-readable label for the target.
The details identifying the target. Which fields it carries depends on type; the shape for each type is listed below. Two targets of the same type with the same metadata are the same target.
One of the following:
Rest Endpoint Metadata
The HTTP method (e.g. GET, POST).
The API endpoint path.
The hostname of the API (e.g. api.example.com).
The API version string (e.g. v1).
Documentation Metadata
The URL of the documentation page.
The section heading within the page.
The documentation version string.
Cli Command Metadata
The CLI command name.
The subcommand path, which may be multi-word (e.g. "container run").
The CLI version string.
The documented flags and args, e.g. ["--rm", "--network"].
The number of feedback items attached to this target.
The all-time thumbs-up count.
The all-time thumbs-down count.
reaction_up minus reaction_down.
The ISO 8601 timestamp when the target was created.
The ISO 8601 timestamp when the target was last modified.
The response metadata for a single resource.
The links for the resource in data.
Where to call this resource in this API, for example /api/v0/feedback/8x7k2mN.
The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.
Where a person can open this resource in InputBuffer, for example /o/yoyodyne/feedback/8x7k2mN. Use it to link a user straight to the page. web is null when the resource has no page of its own.
The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.
The links for the objects embedded in this resource, keyed by the field each one sits at. A value is null when the embedded object has nothing to link to. {} when the resource embeds nothing.
401The API token is missing, malformed, or revoked.
The API token is missing, malformed, or revoked.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
403The token is valid but not permitted to perform this action.
The token is valid but not permitted to perform this action.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
404No target matches this ID in your organization (target-not-found).
No target matches this ID in your organization (target-not-found).
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
409The request would collide with an existing resource.
The request would collide with an existing resource.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
415The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.
The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
422A required field is missing or a field value is invalid. Check field.
A required field is missing or a field value is invalid. Check field.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
500Something went wrong on our end.
Something went wrong on our end.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
/api/v0/targets/{target_id}Delete a target
Delete a target. We can't bring it back. Any feedback attached to it is safe and stays in your feedback list; it just no longer points to this target.
A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.
No response body
401The API token is missing, malformed, or revoked.
The API token is missing, malformed, or revoked.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
403The token is valid but not permitted to perform this action.
The token is valid but not permitted to perform this action.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
404No target matches this ID in your organization (target-not-found).
No target matches this ID in your organization (target-not-found).
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
415The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.
The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
500Something went wrong on our end.
Something went wrong on our end.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
/api/v0/targets/{target_id}/feedbackList feedback attached to a target
Retrieve the feedback attached to this target, most recently created first. These are the same feedback objects GET /api/v0/feedback returns.
A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.
Which page to return. Starts at 1.
How many results to return per page.
The feedback attached to this target.
A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.
A short summary of the feedback.
The full text of the feedback or bug report.
Whether this feedback needs human review.
A free-form identifier supplied at creation for whoever submitted this feedback, such as your own user id or an anonymous token. Treated as an opaque string and never parsed.
Where this feedback is in routing.
pending: routing has not finished yet. ReadGET /api/v0/feedback/{feedback_id}again for the result.routed: routing finished. FetchGET /api/v0/feedback/{feedback_id}/buffersfor the buffers it chose; an empty list means nothing matched, which is a result rather than an error.skipped: routing did not run, because AI routing is turned off for your organization, or because your organization has no buffers and does not create them automatically.failed: routing could not be completed.GET /api/v0/feedback/{feedback_id}/buffersshows only the buffers you assigned by hand. Run routing again from the feedback's page.
The ISO 8601 timestamp when the feedback was created.
The ISO 8601 timestamp when the feedback was last modified.
The response metadata for a collection.
The page this response came from. Starts at 1.
The number of items per page.
The total number of items across all pages.
The total number of pages.
The path to the next page, carrying the same filters, or null when you are on the last page. Request it as-is rather than building your own query string.
The path to the previous page, carrying the same filters, or null on page 1.
The links for the collection itself, carrying the filters and page from this request.
Where to call this resource in this API, for example /api/v0/feedback/8x7k2mN.
The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.
Where a person can open this resource in InputBuffer, for example /o/yoyodyne/feedback/8x7k2mN. Use it to link a user straight to the page. web is null when the resource has no page of its own.
The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.
The links for each item in data, keyed by that item's id.
401The API token is missing, malformed, or revoked.
The API token is missing, malformed, or revoked.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
403The token is valid but not permitted to perform this action.
The token is valid but not permitted to perform this action.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
404No target matches this ID in your organization (target-not-found).
No target matches this ID in your organization (target-not-found).
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
500Something went wrong on our end.
Something went wrong on our end.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
/api/v0/targets/import/oasImport targets from an OpenAPI spec
Create one rest_endpoint target for every operation in an OpenAPI document: a GET and a POST on the same path become two targets. Existing targets are left untouched rather than duplicated, so re-importing an evolved spec adds only what is new and the call is safe to repeat.
The response carries counts rather than the targets themselves. Fetch GET /api/v0/targets afterwards for the targets it made.
A parsed OpenAPI document. Only paths is read. Each path plus each HTTP method under it becomes one target, with metadata of {method, path} and a display name like GET /v1/search.
The number of targets created by this import.
The number of operations that already had a target, left untouched.
The total number of operations found in the spec, equal to created plus existing.
The response metadata. Always present, and empty here because the response names no resource that could be linked to.
401The API token is missing, malformed, or revoked.
The API token is missing, malformed, or revoked.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
403The token is valid but not permitted to perform this action.
The token is valid but not permitted to perform this action.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
415The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.
The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
422A required field is missing or a field value is invalid. Check field.
A required field is missing or a field value is invalid. Check field.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.
500Something went wrong on our end.
Something went wrong on our end.
A URI identifying the error type. Stable across releases, so it is safe to switch on.
A short label for the error type.
An explanation of this specific occurrence. May change between releases, so don't parse it.
The HTTP status code, mirroring the response status.
Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.
Which request field caused the error. Present only on missing-required-field and invalid-field-value.