request-model-training-data.txt

get   List all the sub accounts under the master account
post   Create a sub account under the master account. <aside>Your account must be a master account and have this privilege to create sub account. Zoom only assigns this privilege to trusted partners. The created user will not receive a confirmation email.</aside>.
get   Retrieve a sub account under the master account. <aside>Your account must be a master account and have this privilege to read sub accounts. Zoom only assigns this privilege to trusted partners</aside>.
delete   Disassociate a sub account from the master account. This will leave the account intact but the sub account will not longer be associated with the master account.
put   Update a sub account's options under the master account
get   Retrieve a sub account's settings under the master account
put   Update a sub account's settings under the master account
get   Retrieve a sub account's managed domains under the master account
get   Retrieve billing information for a sub account under the master account
put   Update billing information for a sub account under the master account <aside>Only for the sub account which is a paid account and paid by master account</aside>
get   Retrieve plan information for a sub account under the master account  <aside>Only for the sub account which is paid by master account</aside>
post   Subscribe plans for a sub account of the master account <aside>Can only subscribe plans for the sub account which is a free account and paid by master account</aside>
put   Update a base plan for a sub account <aside>Can only update a base plan for the sub account which is a paid account and paid by master account</aside>
post   Add an additional plan for sub account <aside>Can only add an Additional plan for the sub account which is a paid account and paid by master account</aside>
put   Update an additional plan for sub account<aside>Can only update an Additional plan for the sub account which is a paid account and paid by master account</aside>
get   List groups under your account
post   Create a group under your account
get   Retrieve a group under your account
put   Update a group under your account
delete   Delete a group under your account
get   List a group's members under your account
post   Add members to a group under your account
delete   Delete a member from a group under your account
get   List H.323/SIP Devices on your Zoom account.
post   Create a H.323/SIP Device on your Zoom account
put   Update a H.323/SIP Device on your Zoom account
delete   Delete a H.323/SIP Device on your Zoom account
get   List Tracking Fields on your Zoom account.
post   Create a Tracking Field on your Zoom account
get   Retrieve a tracking field
put   Update a Tracking Field on your Zoom account
delete   Delete a Tracking Field on your Zoom account
get   List IM groups under your account
post   Create a IM Group under your account
get   Retrieve an IM Group under your account
put   Update an IM Group under your account
delete   Delete an IM Group under your account
get   List an IM Group's members under your account
post   Add members to an IM Group under your account
delete   Delete a member from an IM Group under your account
get   Retrieve IM Chat sessions for a specified period <aside>This API only supports oauth2.</aside>
get   Retrieve IM Chat messages for a specified period <aside>This API only supports oauth2.</aside>
get   List meetings for a user
post   Create a meeting for a user <aside>The expiration time of start_url is two hours. But for API users, the expiration time is 90 days.</aside>
get   Retrieve a meeting's details
put   Update a meeting's details
delete   Delete a meeting
put   Update a meeting's status
get   Retrieve a meeting invitation
get   List registrants of a meeting
post   Register a participant for a meeting
put   Update a meeting registrant's status
put   Update a meeting's live stream
put   Update a meeting's live stream status
get   Retrieve ended meeting details
get   Retrieve ended meeting participants
get   List of ended meeting instances
get   List polls of a meeting
post   Create a poll for a meeting
get   Retrieve a meeting's poll
put   Update a meeting's poll
delete   Delete a meeting's Poll
get   List all the recordings
get   Retrieve a meeting’s all recordings
delete   Delete a meeting's recordings
delete   Delete one meeting recording file
put   Recover a meeting's recordings
put   Recover a single recording
get   Retrieve a meeting recording's settings
put   Update a meeting recording's settings
get   List live meetings or past meetings for a specified period
get   Retrieve live or past meetings detail
get   Retrieve live or past meetings participants
get   Retrieve live or past meetings participant quality of service
get   Retrieve list of live or past meetings participants quality of service
get   Retrieve sharing/recording details of live or past meetings participant
get   List live webinars or past webinars for a specified period
get   Retrieve live  or past webinars detail
get   Retrieve live or past webinar participants
get   Retrieve live or past webinar participant quality of service
get   Retrieve list of live or past webinar participants quality of service
get   Retrieve sharing/recording details of live or past webinar participant
get   List all zoom rooms on account
get   Retrieve zoom room on account
get   Get CRC Port usage hour by hour for a specified time period <aside class='notice'>We will report a maximum of one month. For example, if "from" is set to "2017-08-05" and "to" is "2017-10-10" we will adjust "from" to "2017-09-10"</aside>.
get   Retrieve metrics of Zoom IM
get   Retrieve daily report for one month, can only get daily report for recent 6 months
get   Retrieve active or inactive hosts report for a specified period
get   Retrieve ended meetings report for a specified period
get   Retrieve ended meeting details report
get   Retrieve ended meeting participants report
get   Retrieve ended meeting polls report
get   Retrieve ended webinar details report
get   Retrieve ended webinar participants report
get   Retrieve ended webinar polls report
get   Retrieve ended webinar Q&A report
get   Retrieve telephone report for a specified period <aside>Toll Report option would be removed.</aside>.
get   Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days.
get   Retrieve TSP information on account level
put   Update TSP information on account level
get   List users on your account
post   Create a user on your account
get   Retrieve a user on your account
put   Update a user on your account
delete   Delete a user on your account
get   List a user's assistants
post   Add assistants to a user
delete   Delete all of a user'sassitants
delete   Delete one of a user's assistants
get   List a user's schedulers
delete   Delete all of a user'schedulers
delete   Delete one of a user's schedulers
post   Upload a user's profile picture
get   Retrieve a user's settings
put   Update a user's settings
put   Update a user's status
put   Update a user's password
get   Retrieve a user's permissions
get   List user's PAC accounts
get   List user's TSP accounts
post   Add a user's TSP account
get   Retrieve a user's TSP account
put   Update a user's TSP account
delete   Delete a user's TSP account
get   Retrieve a user's token
delete   Revoke a user's SSO token
put   Update a user's email
get   Check if the zpk is expired. The zpk is used to authenticate a user.
get   Check if the user email exists
get   Check if the user's personal meeting room name exists
get   List webinars for a user
post   Create a webinar for a user <aside>The expiration time of start_url is two hours. But for API users, the expiration time is 90 days.</aside>
get   Retrieve a webinar
put   Update a webinar
delete   Delete a webinar
put   Update a webinar's status
get   List panelists for a webinar
post   Add panelist to webinar
delete   Remove all panelists from a webinar
delete   Remove a panelist from a webinar
get   List registrants for a webinar
post   Add a registrant for a webinar
put   Update a webinar registrant's status
get   List of ended webinar instances
get   List polls of a webinar
post   Create a poll for a webinar
get   Retrieve a webinar's poll
put   Update a webinar's poll
delete   Delete a webinar's Poll
put   Switch webhook version
get   List webhooks for a account
post   Create a webhook for a account
get   Retrieve a webhook
put   Update a webhook
delete   Delete a webhook
get   Get Hypermedia links to resources accessible in GitHub's REST API
get   Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint.
post   Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.
get   Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."
put   Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."
delete   Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint.
get   Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to.
post   Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.
delete   Removes a GitHub App installation suspension.
delete   Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.
get   You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`.
delete   Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).
delete   OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).
post   Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.
get   Lists all the emojis available to use on GitHub.
get   Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
put   Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
delete   Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
put   Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
post   Creates a new self-hosted runner group for an enterprise.
delete   Deletes a self-hosted runner group for an enterprise.
put   Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.
put   Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
get   Gets the free and paid storage used for GitHub Packages in gigabytes.
invalid   Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
delete   Revokes the installation token you're using to authenticate as an installation and access this endpoint.
get   Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
get   Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/)."
get   Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
invalid   Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
post   Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`.
put   If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.
put   Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.
put   Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
post   Creates a new self-hosted runner group for an organization.
put   Updates the `name` and `visibility` of a self-hosted runner group in an organization.
delete   Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)."
put   Adds a self-hosted runner to a runner group configured in an organization.
delete   Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
get   Gets a specific self-hosted runner configured in an organization.
invalid   Creates or updates an organization secret with an encrypted value. Encrypt your secret using
get   Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.
get   Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.
delete   Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.
get   Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.
get   Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.
put   Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.
delete   Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.
put   Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.
get   Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products). An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://help.github.com/en/articles/about-authentication-with-saml-single-sign-on).
delete   Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products). An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access.
post   Here's how you can create a hook that posts payloads in JSON format:
get   Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)."
put   Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)."
get   Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)."
put   Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)."
put   Enables an authenticated GitHub App to find the organization's installation information.
get   Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.
delete   Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.
get   Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.
delete   Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.
get   Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
put   Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.
get   The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.
post   Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications).
post   Initiates the generation of a migration archive.
post   Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
post   Restores a specific package version in an organization.
post   The user can publicize their own membership. (A user cannot publicize the membership for another user.)
post   Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
post   To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)".
put   To edit a team, the authenticated user must either be an organization owner or a team maintainer.
post   Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
put   Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
post   Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
put   Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
post   Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.
put   Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
put   Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.
put   To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
put   Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
put   Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.
put   Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
put   Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
post   Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate using an access token with the `repo` scope to use this endpoint. #### Example using registration token Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. ```./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```
post   Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. You must authenticate using an access token with the `repo` scope to use this endpoint. #### Example using remove token To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.```./config.sh remove --token TOKEN```
delete   Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. You must authenticate using an access token with the `repo` scope to use this endpoint.
get   Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
post   Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
post   Approve or reject pending deployments that are waiting on approval by a required reviewer.
post   Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
invalid   Creates or updates a repository secret with an encrypted value. Encrypt your secret using
invalid   Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
invalid   Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
post   Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)".
put   Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.
post   By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites.
post   Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.
post   Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
put   Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.
post   Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.
post   Create a comment for a commit using its `:commit_sha`.
post   Creates a new file or replaces an existing file in a repository.
post   Users with `push` access can create deployment statuses for a given deployment.
post   Create a fork for the authenticated user.
post   Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).
post   The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
put   Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)."
put   Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)."
post   This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.
post   This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.
put   An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API
post   Start a source import to a GitHub repository using GitHub Importer.
put   Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.
post   Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.
put   Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.
post   Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.
post   Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment.
put   Issue owners and users with push access can edit an issue.
put   Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
delete   Removes any previous labels and sets the new labels for an issue.
put   Users with push access can unlock an issue's conversation.
put   Users with push access can lock an issue or pull request's conversation.
post   Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue.
post   You can create a read-only deploy key.
invalid   Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
post   Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."
put   Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
post   Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
post   Enables you to edit a review comment.
post   Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment.
put   Update the review summary comment with new text.
put   Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
post   Users with push access to the repository can create a release.
put   Users with push access to the repository can edit a release asset.
put   Users with push access to the repository can edit a release.
put   Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.
post   Users with push access in a repository can create commit statuses for a given SHA.
put   If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely.
post   Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)".
post   Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)".
post   Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
delete   Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
invalid   **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.
put   **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. Allows you to change a provisioned groups individual attributes. To change a groups values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).
put   Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).
put   To edit a team, the authenticated user must either be an organization owner or a team maintainer.
post   Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion`.
put   Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion`.
post   Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion`.
put   To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.
invalid   Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.
put   Sets the visibility for your primary email addresses.
get   This endpoint is accessible with the `user` scope.
post   Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.
put   Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key`.
delete   Remove a single repository from an installation. The authenticated user must have admin access to the repository.
delete   Removes any interaction restrictions from your public repositories.#
delete   Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key`.
post   Initiates the generation of a user migration archive.
post   Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.
post   Restores a package version owned by the authenticated user.
invalid   add and update something
invalid   update and add x
invalid   add and update something
invalid   update and add x
invalid   update and remove a form from db
invalid   update and remove
invalid   update and remove an object from db
invalid   update and remove a table from sql
get   retrieve food from db
get   retrieve data from db
get   retrieve table from sql-db
delete   remove class from db
delete   remove data from db
delete   remove table from sql-db
delete   remove a form from db
delete   remove an object from the source
get   retrieve data-source from database
get   retrieve an object from a database
get   retrieve an object
get   retrieve food from local
get   get something
get   get data from x
get   request to get following data
get   request to get specific data about the user
get   get specific name of user
get   get name of user
get   get name
get   get surname
get   get information about the user
get   get cat food
delete   delete food
post   create new object
put   update new object
get   retrieve new object from db
delete   remove object from db
invalid   add and remove something
invalid   update and remove x
get   List Messages
post   Create Message
delete   Delete Message
get   Get Message
put   Update Message
get   Gets a list of favorites defined within an Application Insights component.
delete   Remove a favorite that is associated to an Application Insights component.
get   Get a single favorite by its FavoriteId, defined within an Application Insights component.
put   Updates a favorite that has already been added to an Application Insights component.
put   Adds a new favorites to an Application Insights component.
get   Gets the list of annotations for a component for given time range
post   Create an Annotation of an Application Insights component.
delete   Delete an Annotation of an Application Insights component.
get   Get the annotation for given id.
get   Returns an object with the current configuration that Buffer is using, including supported services, their icons and the varying limits of character and schedules.
get   Returns an object with a the numbers of shares a link has had using Buffer.
post   "Set the posting schedules for the specified social media profile.
get   Returns details of the posting schedules associated with a social media profile.
get   "Returns an array of updates that are currently in the buffer for an individual social media profile.
post   Edit the order at which statuses for the specified social media profile will be sent out of the buffer.
get   Returns an array of updates that have been sent from the buffer for an individual social media profile.
post   Randomize the order at which statuses for the specified social media profile will be sent out of the buffer.
get   Returns details of the single specified social media profile.
get   Returns an array of social media profiles connected to a users account.
post   Create one or more new status updates.
delete   Permanently delete an existing status update.
get   Returns the detailed information on individual interactions with the social media update such as favorites, retweets and likes.
invalid   Move an existing status update to the top of the queue and recalculate times for all updates in the queue. Returns the update with its new posting time.
invalid   Immediately shares a single pending update and recalculates times for updates remaining in the queue.
put   Edit an existing, individual status update.
get   Returns a single social media update.
get   Returns a single user.
get   Get API usage by application for time frame specified. You can go as far back as 30 days ago, and can ask for up to a 48 hour window of time in a single request. You must be authenticated with at least the ReadUserData permission to access this endpoint.
get   Get list of applications created by Bungie.
get   Returns community content.
get   Returns a content item referenced by id
get   Returns the newest item that matches a given tag and Content Type.
get   Gets an object describing a particular variant of content.
get   Gets content based on querystring information passed in. Provides basic search and text search capabilities.
get   Searches for Content Items that match the given Tag and Content Type.
get   Search for Help Articles.
post   Equip an item. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.
post   Equip a list of items by itemInstanceIds. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline. Any items not found on your character will be ignored.
put   Insert a plug into a socketed item. I know how it sounds, but I assure you it's much more G-rated than you might be guessing. We haven't decided yet whether this will be able to insert plugs that have side effects, but if we do it will require special scope permission for an application attempting to do so. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline. Request must include proof of permission for 'InsertPlugs' from the account owner.
post   Extract an item from the Postmaster, with whatever implications that may entail. You must have a valid Destiny account. You must also pass BOTH a reference AND an instance ID if it's an instanced item.
put   Set the Lock State for an instanced item. You must have a valid Destiny Account.
put   Set the Tracking State for an instanced item, if that item is a Quest or Bounty. You must have a valid Destiny Account. Yeah, it's an item.
post   Transfer an item to/from your vault. You must have a valid Destiny account. You must also pass BOTH a reference AND an instance ID if it's an instanced item. itshappening.gif
get   Gets a page list of Destiny items.
get   Provide the result of the user interaction. Called by the Bungie Destiny App to approve or reject a request.
get   Returns the action token if user approves the request.
post   Initialize a request to perform an advanced write action.
get   Returns information on the weekly clan rewards and if the clan has earned them or not. Note that this will always report rewards as not redeemed.
get   Returns the current version of the manifest as a json object.
get   Returns the static definition of an entity of the given Type and hash identifier. Examine the API Documentation for the Type Names of entities that have their own definitions. Note that the return type will always *inherit from* DestinyDefinition, but the specific type returned will be the requested entity type if it can be found. Please don't use this as a chatty alternative to the Manifest database if you require large sets of data, but for simple and one-off accesses this should be handy.
get   Gets public information about currently available Milestones.
get   Gets custom localized content for the milestone of the given hash, if it exists.
get   Returns a list of Destiny memberships given a full Gamertag or PSN ID. Unless you pass returnOriginalProfile=true, this will return membership information for the users' Primary Cross Save Profile if they are engaged in cross save rather than any original Destiny profile that is now being overridden.
get   Gets aggregated stats for a clan using the same categories as the clan leaderboards. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.
get   Gets historical stats definitions.
get   Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.
get   Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.
get   Gets the available post game carnage report for the activity ID.
post   Report a player that you met in an activity that was engaging in ToS-violating activities. Both you and the offending player must have played in the activityId passed in. Please use this judiciously and only when you have strong suspicions of violation, pretty please.
get   Get items available from vendors where the vendors have items for sale that are common for everyone. If any portion of the Vendor's available inventory is character or account specific, we will be unable to return their data from this endpoint due to the way that available inventory is computed. As I am often guilty of saying: 'It's a long story...'
get   Gets historical stats for indicated character.
get   Gets activity history stats for indicated character.
get   Gets all activities the character has participated in together with aggregate statistics for those activities.
get   Gets details about unique weapon usage, including all exotic weapons.
get   Gets aggregate historical stats organized around each character for a given account.
get   Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint has not yet been implemented. It is being returned for a preview of future functionality, and for public comment/suggestion/preparation.
get   Returns Destiny Profile information for the supplied membership.
get   Returns character information for the supplied character.
get   Given a Presentation Node that has Collectibles as direct descendants, this will return item details about those descendants in the context of the requesting character.
get   Get currently available vendors from the list of vendors that can possibly have rotating inventory. Note that this does not include things like preview vendors and vendors-as-kiosks, neither of whom have rotating/dynamic inventories. Use their definitions as-is for those.
get   Get the details of a specific Vendor.
get   Retrieve the details of an instanced Destiny Item. An instanced Destiny item is one with an ItemInstanceId. Non-instanced items, such as materials, have no useful instance-specific details and thus are not queryable here.
get   Returns a summary information about all profiles linked to the requesting membership type/membership ID that have valid Destiny information. The passed-in Membership Type/Membership ID may be a Bungie.Net membership or a Destiny membership. It only returns the minimal amount of data to begin making more substantive requests, but will hopefully serve as a useful alternative to UserServices for people who just care about Destiny data. Note that it will only return linked accounts whose linkages you are allowed to view.
get   Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.
get   Gets a listing of all of this clan's fireteams that are have available slots. Caller is not checked for join criteria so caching is maximized.
get   Gets a listing of all fireteams that caller is an applicant, a member, or an alternate of.
get   Gets a specific fireteam.
get   Gets a listing of all public fireteams starting now with open slots. Caller is not checked for join criteria so caching is maximized.
get   Gets a listing of all topics marked as part of the core group.
get   Gets tag suggestions based on partial text entry, matching them with other tags previously used in the forums.
get   Returns the post specified and its immediate parent.
get   Returns the post specified and its immediate parent of posts that are awaiting approval.
get   Returns a thread of posts at the given parent, optionally returning replies to those posts as well as the original parent.
get   Returns a thread of posts starting at the topicId of the input childPostId, optionally returning replies to those posts as well as the original parent.
get   Gets the post Id for the given content item's comments, if it exists.
get   Get topics from any forum.
get   Gets the specified forum poll.
get   Allows the caller to get a list of to 25 recruitment thread summary information objects.
get   List of available localization cultures
get   Gets any active global alert for display in the forum banners, help pages, etc. Usually used for DOC alerts.
get   Returns a list of all available group avatars for the signed-in user.
get   Returns a list of all available group themes.
get   Gets the state of the user's clan invite preferences for a particular membership type - true if they wish to be invited to clans, false otherwise.
get   Get information about a specific group with the given name and type.
get   Get information about a specific group with the given name and type. The POST version.
get   Gets groups recommended for you based on the groups to whom those you follow belong.
get   Allows a founder to manually recover a group they can see in game but not on bungie.net
post   Search for Groups.
get   Get information about the groups that a given member has applied to or been invited to.
get   Get information about the groups that a given member has joined.
get   Get information about a specific group of the given ID.
post   An administrative method to allow the founder of a group or clan to give up their position to another admin permanently.
get   Get the list of members in a given group who are of admin level or higher.
get   Get the list of banned members in a given group. Only accessible to group Admins and above. Not applicable to all groups. Check group features.
put   Edit an existing group. You must have suitable permissions in the group to perform this operation. This latest revision will only edit the fields you pass in - pass null for properties you want to leave unaltered.
put   Edit an existing group's clan banner. You must have suitable permissions in the group to perform this operation. All fields are required.
put   Edit group options only available to a founder. You must have suitable permissions in the group to perform this operation.
get   Get the list of members in a given group.
post   Approve the given membershipId to join the group/clan as long as they have applied.
post   Approve all of the pending users for the given group.
post   Approve all of the pending users for the given group.
post   Deny all of the pending users for the given group.
post   Deny all of the pending users for the given group that match the passed-in .
post   Invite a user to join this group.
post   Cancels a pending invitation to join a group.
get   Get the list of users who have been invited into the group.
get   Get the list of users who are awaiting a decision on their application to join a given group. Modified to include application info.
post   Bans the requested member from the requested group for the specified period of time.
post   Kick a member from the given group, forcing them to reapply if they wish to re-join the group. You must have suitable permissions in the group to perform this operation.
put   Edit the membership type of a given member. You must have suitable permissions in the group to perform this operation.
post   Unbans the requested member, allowing them to re-apply for membership.
get   Gets a list of available optional conversation channels and their settings.
post   Add a new optional conversation/chat channel. Requires admin permissions to the group.
put   Edit the settings of an optional conversation/chat channel. Requires admin permissions to the group.
get   Get the common settings used by the Bungie.Net environment.
post   Apply a partner offer to the targeted user. This endpoint does not claim a new offer, but any already claimed offers will be applied to the game if not already.
post   Claim a partner offer as the authenticated user.
get   Returns the partner sku and offer history of the targeted user. Elevated permissions are required to see users that are not yourself.
get   Returns trending items for Bungie.net, collapsed into the first page of items per category. For pagination within a category, call GetTrendingCategory.
get   Returns paginated lists of trending items for a category.
get   Returns the detailed results for a specific trending entry. Note that trending entries are uniquely identified by a combination of *both* the TrendingEntryType *and* the identifier: the identifier alone is not guaranteed to be globally unique.
get   Returns a list of all available user themes.
post   Loads a bungienet user by membership id.
get   Returns a list of credential types attached to the requested account
get   Gets any hard linked membership given a credential. Only works for credentials that are public (just SteamID64 right now). Cross Save aware.
get   Returns a list of accounts associated with the supplied membership ID and membership type. This will include all linked accounts (even when hidden) if supplied credentials permit it.
get   Returns a list of accounts associated with signed in user. This is useful for OAuth implementations that do not give you access to the token response.
get   Returns a list of possible users based on the search string
get   Get the user-specific system overrides that should be respected alongside common systems.
post   To search for all calls sent or received by the user. Use "id=0" for the campaignId parameter to query for all calls sent through the POST /calls API. See [call states and results](https://developers.callfire.com/results-responses-errors.html)
post   Use the /calls API to send individual calls quickly. A verified Caller ID and sufficient credits are required to make a call. CallRecipient represents a single recipient identified by phone number or contact id in CallFire system. You can attach user-defined attributes to a Call action via CallRecipient.attributes property, attributes are available in Call action response
get   Searches for all voice broadcasts created by user. Can query on label, name, and the current running status of the campaign. Returns a paged list of voice broadcasts
post   Creates a call broadcast campaign using the Call Broadcast API. Send a CallBroadcast in the message body to add details in a voice broadcast campaign. The campaign can be created without contacts and bare minimum configuration, but contacts will have to be added further on to use the campaign
get   Returns a single CallBroadcast instance for a given call broadcast campaign id
put   This operation lets the user modify the configuration of a voice broadcast campaign after call broadcast campaign is created. See CallBroadcast for more information on what can/can't be updated on this API
post   Archives a voice broadcast (voice broadcast will be hidden in search results)
get   This endpoint will enable the user to page through all of the batches for a particular voice broadcast campaign
post   The 'add batch' API allows user to add additional batches to an already created voice broadcast campaign. The added batch will go through the CallFire validation process, unlike in the recipients version of this API. That is why you can use the scrubDuplicates flag to remove duplicates from your batch. Batches may be added as a contact list id, a list of contact ids, or a list of numbers
get   This endpoint will enable the user to page through all calls for a particular call broadcast campaign
post   Use this API to add the recipients to an existing voice broadcast. Post a list of Recipient objects to be added to the voice broadcast campaign. These contacts will not go through validation process, and will be acted upon as they are added. Recipients may be added as a list of contact ids, or list of numbers
post   Start a voice broadcast
get   Returns broadcast statistics like total number of sent/received actions, total cost, number of remaining outbound actions, error count, etc
post   Stop a voice broadcast
post   This operation lets the user to disable/enable undialed recipients in created broadcast
get   Returns metadata of recording of a particular call. Metadata contains a link to a MP3 recording
get   Returns an MP3 recording of particular call, response contains binary data, content type is 'audio/mpeg'
get   Returns a single Call instance for a given call id.
get   Returns a list of recordings metadata of particular call. Metadata contains link to a MP3 recording
get   Returns recording metadata of particular call. Metadata contains link to a MP3 recording
get   Returns a MP3 recording of a particular call, response contains binary data, content type is 'audio/mpeg'
get   Returns a single Batch instance for a given batch id. This API is useful for determining the state of a validating batch
put   Updates a single Batch instance, currently batch can only be turned "on/off"
get   To find all campaign sounds which were created by user. Returns all sounds available to be used in campaigns
post   Use this API to create a sound via a phone call. Provide the required phone number in the CallCreateSound object inside the request, and user will receive a call shortly after with instructions on how to record a sound over the phone.
post   Create a campaign sound file via a supplied .mp3 or .wav file
post   Use this API to create a sound file via a supplied string of text. Add a text in the TextToSpeech.message field, and pick a voice in the TextToSpeech.voice field. Available voices are: MALE1, FEMALE1, FEMALE2, SPANISH1, FRENCHCANADIAN1
delete   Deletes a single campaign sound instance for a specific campaign sound id, this operation does not delete sound completely, it sets sound status to ARCHIVED which means that sound will no longer appear in 'find' operation results, but still accessible via 'get' operation
get   Returns a single CampaignSound instance for a given sound id in campaign. This is a meta data to the sounds. No audio data is returned from this API
post   Download the MP3 version of a hosted file. This is an audio data endpoint. Returns binary response of the 'audio/mpeg' content type
post   Download the WAV version of the hosted file. This is an audio data endpoint. Returns binary response of the 'audio/mpeg' content type
post   Find user's contacts by id, contact list, or on any property name. Returns a paged list of contacts
post   Creates contacts in CallFire system. Only values from the next list can be used as external system parameter in contact creation: **NATION_BUILDER, SALES_FORCE_CONTACTS, SALES_FORCE_LEADS, SALES_FORCE_REPORTS, ZOHO, NETSUITE, MAIL_CHIMP**. See [contacts validation rules](https://www.callfire.com/help/docs/getting-started/managing-contacts/validating-contacts#section1)
get   Searches for all Do Not Contact (DNC) objects created by user. These DoNotContact entries only affect calls/texts/campaigns on this account. Returns a paged list of DoNotContact objects
invalid   Add or update a list of Do Not Contact (DNC) contact entries. Can toggle whether the DNCs are enabled for calls/texts.
delete   Delete Do Not Contact (DNC) contact entries contained in source.
get   Searches for a UniversalDoNotContact object for a given phone number. Shows whether inbound/outbound actions are allowed for a given number
delete   Delete a Do Not Contact (DNC) contact entry.
get   Get Do Not Contact (DNC) object create by user. This DoNotContact entry only affects calls/texts/campaigns on this account.
put   Update a Do Not Contact (DNC) contact entry. Can toggle whether the DNC is enabled for calls/texts.
get   Searches for all contact lists which are available for the current user. Returns a paged list of contact lists
post   Creates a contact list for use with campaigns using 1 of 3 inputs. A List of Contact objects, a list of String E.164 numbers, or a list of CallFire contactIds can be used as the data source for the created contact list. After contact list is added into the CallFire system, contact lists goes through seven system safeguards that check the accuracy and consistency of the data. For example, our system checks that contact number is formatted correctly, is valid, is not duplicated in another contact list, or is not added on a specific DNC list. You can configure to keep/merge or remove contacts which do not complies these rules. If contacts were not added to a contact list after the validation, this means the data needs to be properly formatted and corrected before calling this API
post   Creates a contact list to be used with campaigns through uploading a .csv file. Returns the id of created list
delete   Deletes a contact list, included contacts will not be deleted.
get   Returns a single ContactList instance for a given contact list id
put   Updates contact list instance.
delete   Deletes contacts from a contact list. List the contact ids in request to delete multiple contacts with one request.
get   Searches for all entries in a contact list with specified id. Returns a paged list of contact entries
put   Adds contacts to a contact list. Available contact sources are: list of the contact entities, list of ids of existing contacts in user's account, list of phone numbers in E.164 format (11-digits)
delete   Deletes a single contact from a contact list
delete   Deletes a contact instance from account
get   Returns a Contact instance for a given contact id. Deleted contacts can be still retrieved but will be marked as deleted. Deleted contacts will not be shown in search request.
put   Updates a single contact instance with id specified. See [contact validation rules](https://www.callfire.com/help/docs/getting-started/managing-contacts/validating-contacts#section1)
get   Searches for all texts and calls attributed to a contact. Returns a list of calls and texts a contact has been involved with
get   Searches for all keywords available for purchase on the CallFire platform. If a keyword appears in the response, it is available for purchase. List the 'keywords' in a query parameter to search for multiple keywords (at least one keyword should be sent in request). Keyword should only consist of uppercase and lowercase letters and numbers. Number of characters must be greater than 2, but less than 65.
get   Searches for all keywords owned by user. A keyword lease is the ownership information involving a keyword
get   Searches for all keyword lease configs for the user. Returns a paged list of KeywordConfig
get   Returns a single KeywordConfig instance for a given keyword lease
put   Updates a keyword lease configuration. Use this API endpoint to enable/disable inbound SMS forwarding, set forward number. Forward number must be in E.164 format)
get   Get keyword by id
get   Searches for all keywords owned by user
put   Updates a keyword lease. Turns the autoRenew on/off. Configure double opt in feature. Add/remove contact list from keyword.
get   Searches for the specific keyword to purchase on the CallFire platform. Returns 'true' if keyword is available. Keyword should only consist of uppercase and lowercase letters and numbers. Number of characters must be greater than 2, but less than 65.
get   Searches for the user account details. Details include name, email, and basic account permissions. For authentication use api credentials.
get   Searches for all credentials generated by user. Returns a paged list of the API credentials. Only ACCOUNT_HOLDER can invoke this API. For authentication use account credentials.
post   Creates an API credentials for the CallFire API. This endpoint requires full CallFire account credentials to be used, authenticated using Basic Authentication. At the moment user provides only the name for the credentials. The generated credentials can be used to access any CallFire APIs. For authentication use account credentials.
delete   Deletes a specified API credential. Currently, removes the ability to access the API. Only ACCOUNT_HOLDER can invoke this API. For authentication use account credentials.
get   Returns an API credential instance for a given api credential id. Only ACCOUNT_HOLDER can invoke this API. For authentication use account credentials.
post   Disables a specified API credential. Currently, removes the ability to access the API. Only ACCOUNT_HOLDER can invoke this API. For authentication use account credentials.
post   Enables a specified API credential. Currently, adds the ability to access the API. Only ACCOUNT_HOLDER can invoke this API. For authentication use account credentials.
get   Find credit usage for the user. Returns credits usage for time period specified or if unspecified then total for all time. For authentication use api credentials.
get   Searches for the data of a billing plan usage for the user. Returns the data of a billing plan usage for the current month. For authentication use api credentials.
get   Returns a list of verified caller ids. If the number is not shown in the list, then it is not verified. In this case sending of a verification code is required. For authentication use api credentials.
post   Generates and sends a verification code to the phone number provided in the path. The verification code is delivered via a phone call. This code needs to be submitted to the verify caller id API endpoint to complete verification. For authentication use api credentials.
post   With the verification code received from the Create caller id endpoint, a call to this endpoint is required to finish verification. For authentication use api credentials.
get   Find media files created by user
post   Uploads media file to account, acceptable media formats: bmp, gif, jpg, m4a, mp3, mp4, png, wav
get   Download a media file. Available types of files: bmp, gif, jpg, m4a, mp3, mp4, png, wav. Content type in response depends on 'extension' parameter, e.g. image/jpeg, image/png, audio/mp3, etc
get   Get media resource by id
post   Download a media file. Available types of files: bmp, gif, jpg, m4a, mp3, mp4, png, wav. Content type in response depends on 'extension' parameter, e.g. image/jpeg, image/png, audio/mp3, etc
post   Download a MP3 media, endpoint returns application/binary content-type
get   Searches for all numbers leased by account user. This API is useful for finding all numbers currently owned by the user. Returns a paged list of number leases.
get   Searches for all number lease configs for the user. Returns a paged list of NumberConfig
get   Returns a single NumberConfig instance for a given number lease
put   Updates a phone number lease configuration. Use this API endpoint to add an Inbound IVR or Call Tracking feature to a CallFire phone number. Call tracking configuration allows you to track the incoming calls, to analyze and to respond customers using sms or voice replies. For more information see [call tracking page](https://www.callfire.com/products/call-tracking)
get   Returns a single NumberLease instance for a given number
put   Updates a number lease instance. Ability to turn on/off autoRenew and toggle call/text features for a particular number
get   Searches for numbers available for purchase in CallFire local numbers catalog . At least one additional parameter is required. User may filter local numbers by their region information. If all numbers with desirable zip code is already busy search will return available numbers with nearest zip code.
get   Searches for region information. Use this API to obtain detailed region information that can be used to query for more specific phone numbers than a general query.
get   Searches for the toll free numbers which are available for purchase in the CallFire catalog
get   Searches for account orders
post   Purchase keywords. Send a list of available keywords into this API to purchase them using CallFire credits. Make sure the account has enough credits before trying to purchase the keywords. Keyword should only consist of uppercase and lowercase letters and numbers. Number of characters must be greater than 2, but less than 65.
post   Purchase numbers. There are many ways to purchase a number. Set either 'tollFreeCount' or 'localCount' along with some querying fields to purchase numbers by bulk query. Set the list of numbers to purchase by list. Available numbers will be purchased using CallFire credits owned by the user. Make sure the account has enough credits before trying to purchase
get   Returns a single NumberOrder instance for a given order id. Order contains information about purchased keywords, local, toll-free numbers
get   Get delivery reports
get   Searches for texts sent or received by user. Use "campaignId=0" parameter to query for all texts sent through the POST /texts API. See [call states and results](https://developers.callfire.com/results-responses-errors.html)
post   Use the /texts API to send individual texts quickly. By default all texts are going out from CallFire's dedicated short code. Example: 67076, 818818 etc
get   Find all text autoreplies created by user. Returns a paged list of TextAutoReply
post   CallFire gives you possibility to set up auto reply messages for your numbers and keywords. You can set a general auto reply for anyone who texts your number, keyword, and/or include a text to match, so that the auto reply would be sent only to those who text the matched text
delete   Deletes a text auto reply and removes the configuration. Can not delete a TextAutoReply which is currently active for a campaign
get   Returns a single TextAutoReply instance for a given text auto reply id
get   Searches for all text broadcasts created by user. Can query on label, name, and the current running status of the campaign. Returns a paged list of text broadcasts
post   Creates a text broadcast campaign using the Text Broadcast API. Send a TextBroadcast object in the message body to detail a text broadcast campaign. A campaign can be created without contacts and with bare minimum configuration, but contacts have to be added further on to use the campaign. It supports scheduling, retry logic, pattern-based messages.
get   Returns a single TextBroadcast instance for a given text broadcast id
put   Allows modifying the configuration of existing text broadcast campaign. See TextBroadcast for more information on what can/can't be updated on this API
post   Archives a text broadcast (and hides it in the search results)
get   This endpoint will enable the user to page through all of the batches for a particular text broadcast campaign
post   Allows adding an extra batches to an already created text broadcast campaign. The batches which being  added pass the CallFire validation process (unlike in the recipients version of this API). That is why using of a scrubDuplicates flag remove duplicates from your batch. Batches may be added as a contact list id, a list of contact ids, or a list of numbers
put   Use this API to add recipients to a text broadcast which is already created. Post a list of Recipient objects to be immediately added to the text broadcast campaign. These contacts will not go through validation process, and will be acted upon as they are added. Recipients may be added as a list of contact ids, or list of numbers
post   Starts a text broadcast
get   Returns the broadcast statistics. Example: total number of the sent/received actions, total cost, number of remaining outbound actions, error count, etc
post   Stops a text broadcast
get   This endpoint will enable the user to page through all of the texts for a particular text broadcast campaign
post   This operation lets the user to disable/enable undialed contacts in created broadcast
get   Returns a single Text instance for a given text id
get   Searches all webhooks available for a current user. Searches by name, resource, event, callback URL, or whether they are enabled. Returns a paged list of Webhooks
post   Create a Webhook for notification in the CallFire system. Use the webhooks API to receive notifications of important CallFire events. Select the resource to listen to, and then choose the resource events to receive notifications on. When an event triggers, a POST will be made to the callback URL with a payload of notification information. Available resources and their events include 'CccCampaign': ['started', 'stopped', 'finished'], 'CallBroadcast': ['started', 'stopped', 'finished'], 'TextBroadcast': ['started', 'stopped', 'finished'], 'OutboundCall': ['finished'], 'InboundCall': ['finished'], 'OutboundText': ['finished'], 'InboundText': ['finished'], 'ContactList': ['validationFinished', 'validationFailed'], 'MonthlyRenewal': ['failed', 'finished'], 'LowBalance': ['failed', 'finished']. Webhooks support secret token which is used as signing key to HmacSHA1 hash of json payload which is returned in 'X-CallFire-Signature' header. This header can be used to verify callback POST is coming from CallFire. See [security guide](https://developers.callfire.com/security-guide.html)
get   Searches for webhook resources. Available resources include 'CccCampaign': ['started', 'stopped', 'finished'], 'CallBroadcast': ['started', 'stopped', 'finished'], 'TextBroadcast': ['started', 'stopped', 'finished'], 'OutboundCall': ['finished'], 'InboundCall': ['finished'], 'OutboundText': ['finished'], 'InboundText': ['finished'], 'ContactList': ['validationFinished', 'validationFailed'], 'MonthlyRenewal': ['failed', 'finished'], 'LowBalance': ['failed', 'finished']
get   Returns information about supported events for a given webhook resource
delete   Deletes a webhook instance. Will be removed permanently
get   Returns a single Webhook instance for a given webhook id
put   Updates the information in existing webhook
post   Merge and analyse sites within a network channel to determine the best server at a given location. Each site will be dynamically allocated a monochrome colour from a palette and the strongest signal promoted at a given location.
delete   Warning! you could lose data. This function will delete the entry from the database and the file from the disk. Accidental deletion can be reversed by contacting support with biscuits who maintain an offsite backup.
delete   Warning! you could lose data. This function will delete the entry from the database and the file from the disk. Accidental deletion can be reversed by contacting support with biscuits who maintain an offsite backup.
delete   This endpoint removes a Config identified by the `configId` parameter.
get   This endpoint returns the metadata of a Configidentified by the `configId`.
put   This endpoint updates a Config identified by the `configId` parameter.
get   This endpoint returns the list of Feature Flags and Settings that were deleted from the given Config.
get   This endpoint returns the SDK Key for your Config in a specified Environment.
delete   This endpoint removes an Environment identified by the `environmentId` parameter.
get   This endpoint returns the metadata of an Environment identified by the `environmentId`.
put   This endpoint updates an Environment identified by the `environmentId` parameter.
get   This endpoint returns the list of the Organizations that belongs to the user.
get   This endpoint returns the list of Audit log items for a given Organization and the result can be optionally filtered by Product and/or Config and/or Environment.
get   This endpoint returns the list of Members that belongs to the given Organization, identified by the `organizationId` parameter.
delete   This endpoint removes a Member identified by the `userId` from the given Organization identified by the `organizationId` parameter.
post   This endpoint creates a new Product in a specified Organization identified by the `organizationId` parameter, which can be obtained from the [List Organizations](#operation/get-organizations) endpoint.
delete   This endpoint removes a Permission Group identified by the `permissionGroupId` parameter.
get   This endpoint returns the metadata of a Permission Group identified by the `permissionGroupId`.
put   This endpoint updates a Permission Group identified by the `permissionGroupId` parameter.
get   This endpoint returns the list of the Products that belongs to the user.
delete   This endpoint removes a Product identified by the `productId` parameter.
get   This endpoint returns the metadata of a Product identified by the `productId`.
put   This endpoint updates a Product identified by the `productId` parameter.
get   This endpoint returns the list of Audit log items for a given Product and the result can be optionally filtered by Config and/or Environment.
get   This endpoint returns the list of the Configs that belongs to the given Product identified by the`productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
post   This endpoint creates a new Config in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
get   This endpoint returns the list of the Environments that belongs to the given Product identified by the`productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
post   This endpoint creates a new Environment in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
get   This endpoint returns the list of Members that belongs to the given Product, identified by the `productId` parameter.
post   This endpoint invites a Member into the given Product identified by the `productId` parameter.
delete   This endpoint removes a Member identified by the `userId` from the given Product identified by the `productId` parameter.
get   This endpoint returns the list of the Permission Groups that belongs to the given Product identified by the`productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
post   This endpoint creates a new Permission Group in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
get   This endpoint returns the list of the Tags in a specified Product, identified by the `productId` parameter.
post   This endpoint creates a new Tag in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
delete   This endpoint removes a Feature Flag or Setting from a specified Config, identified by the `configId` parameter.
get   This endpoint returns the metadata attributes of a Feature Flag or Setting identified by the `settingId` parameter.
delete   This endpoint deletes a Tag identified by the `tagId` parameter. To remove a Tag from a Feature Flag or Setting use the [Update Flag](#operation/update-setting) endpoint.
get   This endpoint returns the metadata of a Tag identified by the `tagId`.
put   This endpoint updates a Tag identified by the `tagId` parameter.
get   This endpoint returns the list of the Settings that has the specified Tag, identified by the `tagId` parameter.
get   Retrieves all the Languages that the authenticated user or client has permission to access.
post   Creates a Language if it does not yet exist (i.e. if the resource does not have an `id` property yet), or replaces the existing Language resource if it does. Note that this replaces the *entire* Language. It is not a partial update.
put   Performs a partial update the Language whose ID is specified in the URL. If the Language object has an `id` property, is ignored in favor of the ID in the URL.
get   Retrieve all Lexemes that the authenticated user has permission to access. Include a `languageID` query parameter to limit results to Lexemes from a particular Language.
post   Add a new Lexeme. A `languageID` must be provided either as a query parameter, or as an attribute on the Lexeme body.
invalid   Upsert (add or replace) a Lexeme. A `languageID` must be provided either as a query parameter, or as an attribute on the Lexeme body.
put   Perform a partial update on a Lexeme.
get   Retrieve or search patient allergies
post   Create patient allergy
get   Retrieve an existing patient allergy
put   Update an existing patient allergy
put   Update an existing patient allergy
get   Retrieve or search patient amendments. You can only interact with amendments created by your API application
post   Create patient amendments to a patient's clinical records
delete   Delete an existing patient amendment, you can only interact with amendments created by your API application
get   Retrieve an existing patient amendment, you can only interact with amendments created by your API application
put   Update an existing patient amendment, you can only interact with amendments created by your API application
put   Update an existing patient amendment, you can only interact with amendments created by your API application
get   Retrieve or search appointment profiles for a doctor's calendar
post   Create appointment profiles for a doctor's calendar
delete   Delete an existing appointment profile
get   Retrieve an existing appointment profile
put   Update an existing appointment profile
put   Update an existing appointment profile
get   Retrieve or search appointment templates for a doctor's calendar
post   Create appointment templates for a doctor's calendar
delete   Delete an existing appointment template
get   Retrieve an existing appointment template
put   Update an existing appointment template
put   Update an existing appointment template
get   Retrieve or search appointment or breaks.
post   Create a new appointment or break on doctor's calendar
delete   Delete an existing appointment or break
get   Retrieve an existing appointment or break
put   Update an existing appointment or break
put   Update an existing appointment or break
get   Retrieve or search billing profiles
get   Retrieve an existing billing profiles
get   Retrieve or search care plans
get   Retrieve an existing care plan
get   Retrieve or search billing notes
post   Create a new billing note
get   Retrieve an existing billing note
get   Retrieve or search clinical note field types
get   Retrieve an existing clinial note field type
get   Retrieve or search clinical note field values
post   Create clinical note field value
get   Retrieve an existing clinical note field value
put   Update an existing clinical note field value
put   Update an existing clinical note field value
get   Retrieve or search clinical note templates
get   Retrieve an existing clinical note tempalte
get   Retrieve or search communicatioin (phone call) logs
post   Create communication (phone call) logs
get   Retrieve an existing communication (phone call) logs
put   Update an existing communication (phone call) logs
put   Update an existing communication (phone call) logs
get   Retrieve or search patient consent forms
post   Create a patient consent form
get   Retrieve an existing patient consent form
put   Update an existing patient consent form
put   Update an existing patient consent form
post   Assign (apply) a consent form to appointment
post   Unassign (unapply) a consent form from appointment
get   Retrieve or search custom appointment fields
post   Create custom appointment fields
get   Retrieve an existing custom appointment field
put   Update an existing custom appointment field
put   Update an existing custom appointment field
get   Retrieve or search custom demographics fields
post   Create custom demographics fields
get   Retrieve an existing custom demographics field
put   Update an existing custom demographics field
put   Update an existing custom demographics field
get   Retrieve or search custom insurance plan names
get   Retrieve an existing custom insurance plan name
get   Retrieve or search custom vital types
get   Retrieve an existing custom vital type
get   Retrieve or search doctors within practice group
get   Retrieve an existing dcotor
get   Retrieve or search documents
post   Create documents
delete   Delete an existing appointment template
get   Retrieve an existing appointment template
put   Update an existing appointment template
put   Update an existing appointment template
get   Retrieve or search past eligibility checks for patient
get   Retrieve an existing past eligibility check
get   Retrieve or search EOB objects
post   Create EOB object
get   Retrieve an existing EOB object
get   Retrieve or search implantable devices
get   Retrieve an existing implantable device
get   Retrieve or search inventory categories
get   Retrieve an existing inventory category
get   Retrieve or search vaccine inventories
post   Create vaccine inventory
get   Retrieve an existing vaccine inventory
get   Retrieve or search lab order documents
post   Create lab order documents. An example lab workflow is as following:
delete   Delete an existing lab order document
get   Retrieve an existing lab order document
put   Update an existing lab order document
put   Update an existing lab order document
get   Retrieve or search lab orders
post   Create lab orders. An example lab workflow is as following:
delete   Delete an existing lab order
get   Retrieve an existing lab order
put   Update an existing lab order
put   Update an existing lab order
get   Retrieve or search lab results
post   Create lab results. An example lab workflow is as following:
delete   Delete an existing lab result
get   Retrieve an existing lab result
put   Update an existing lab result
put   Update an existing lab result
get   Retrieve or search lab tests
post   Create lab tests. An example lab workflow is as following:
delete   Delete an existing lab test
get   Retrieve an existing lab test
put   Update an existing lab test
put   Update an existing lab test
get   Retrieve or search billing line items
post   Create billing line item for appointments
get   Retrieve an existing billing line item
get   Retrieve or search patient medications
post   Create patient medications
get   Retrieve an existing patient medications
put   Update an existing patient medications
put   Update an existing patient medications
put   Append a message to the "pharmacy_note" section of the prescription, in a new paragraph
get   Retrieve or search messages in doctor's message center
post   Create messages in doctor's message center
delete   Delete an existing message in doctor's message center
get   Retrieve an existing message in doctor's message center
put   Update an existing message in doctor's message center
put   Update an existing message in doctor's message center
get   Retrieve or search offices
get   Retrieve an existing office
put   Update an existing office
put   Update an existing office
put   Add an exam room to the office
get   Retrieve or search patient communications for CQM
post   Create patient communication for CQM
get   Retrieve an existing patient communication for CQM
put   Update an existing patient communication for CQM
put   Update an existing patient communication for CQM
get   Retrieve or search patient flag types
post   Create patient flag types
get   Retrieve an existing patient flag type
put   Update an existing patient flag type
put   Update an existing patient flag type
get   Retrieve or search patient interventions for CQM
post   Create patient intervention for CQM
get   Retrieve an existing patient intervention for CQM
put   Update an existing patient intervention for CQM
put   Update an existing patient intervention for CQM
get   Retrieve or search patient payment logs
get   Retrieve an existing patient payment log
get   Retrieve or search patient payments
post   Create patient payment
get   Retrieve an existing patient payment
get   Retrieve or search patient physical exams for CQM
post   Create patient physical exam for CQM
get   Retrieve an existing patient physical exam for CQM
put   Update an existing patient physical exam for CQM
put   Update an existing patient physical exam for CQM
get   Retrieve or search patient vaccine records
post   Create patient vaccine records
get   Retrieve an existing patient vaccine records
put   Update an existing patient vaccine records
put   Update an existing patient vaccine records
get   Retrieve or search patients
post   Create patient
delete   Delete an existing patient
get   Retrieve an existing patient
put   Update an existing patient
put   Update an existing patient
get   Retrieve patient CCDA
delete   Revoke sent onpatient invites
get   Retrieve or search existing onpatient access invites
post   Send new onpatient invite to patient
get   Retrieve patient QRDA1
get   Retrieve or search prescription messages
get   Retrieve an existing prescription message
get   Retrieve or search patient problems
post   Create patient problems
get   Retrieve an existing patient problems
put   Update an existing patient problems
put   Update an existing patient problems
get   Retrieve or search reminder profiles
post   Create reminder profile
delete   Delete an existing reminder profile
get   Retrieve an existing reminder profile
put   Update an existing reminder profile
put   Update an existing reminder profile
get   Retrieve or search sub vendors
post   Create sub-vendors
delete   Delete an existing sub vendor
get   Retrieve an existing sub vendor
put   Update an existing sub vendor
put   Update an existing sub vendor
get   Retrieve or search task categories
post   Create a task category
get   Retrieve an existing task category
put   Update an existing task category
put   Update an existing task category
get   Retrieve or search task notes
post   Create a task note
get   Retrieve an existing task note
put   Update an existing task note
put   Update an existing task note
get   Retrieve or search task statuses
post   Create a task status
get   Retrieve an existing task status
put   Update an existing task status
put   Update an existing task status
get   Retrieve or search task templates
post   Create a task template
get   Retrieve an existing task template
put   Update an existing task template
put   Update an existing task template
get   Retrieve or search tasks
post   Create a task
get   Retrieve an existing task
put   Update an existing task
put   Update an existing task
get   Retrieve or search insurance transactions associated with billing line items
get   Retrieve an existing insurance transaction
get   Retrieve or search user groups
get   Retrieve an existing user group
get   Retrieve or search users, `/api/users/current` can be used to identify logged in user, it will redirect to `/api/users/{current_user_id}`
get   Retrieve an existing user, `/api/users/current` can be used to identify logged in user, it will redirect to `/api/users/{current_user_id}`
get   This method retrieves the details of specific items that the buyer needs to make a purchasing decision. Note: This is a (Limited Release) available only to select Partners. For this method, only the following fields are returned: eligibleForInlineCheckout, estimatedAvailabilities, itemAffiliateWebURL, itemID, ItemWebURL, legacyItemID, price, sellerItemRevision, and topRatedBuyingExperience. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
get   This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Buy APIs. There are differences between how legacy APIs and RESTful APIs return the identifier of an &quot;item&quot; and what the item ID represents. This method lets you use the legacy item ids retrieve the details of a specific item, such as description, price, and other information the buyer needs to make a purchasing decision. It also returns the RESTful item ID, which you can use with all the Buy API methods. For more information about how to use legacy ids with the Buy APIs, see Legacy API compatibility in the Buying Integration guide. This method returns the item details and requires you to pass in either the item ID of a non-variation item or the item ids of both the parent and child of an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the &quot;parent&quot;. All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc. The fieldgroups URI parameter lets you control what is returned in the response. Setting fieldgroups to PRODUCT, adds additional fields to the default response that return information about the product of the item. For more information, see fieldgroups. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/get_item_by_legacy_id/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/get_item_by_legacy_id/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
get   This method retrieves the details of the individual items in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. You pass in the item group ID as a URI parameter. You use this method to show the item details of items with multiple aspects, such as color, size, storage capacity, etc. This method returns two main containers; items and commonDescriptions. The items container has an array of containers with the details of each item in the group. The commonDescriptions container has an array of containers for a description and the item ids of all the items that have this exact description. Because items within an item group often have the same description, this decreases the size of the response. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/get_items_by_item_group/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
get   This method retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery, and other information the buyer needs to make a purchasing decision. The Buy APIs are designed to let you create an eBay shopping experience in your app or website. This means you will need to know when something, such as the availability, quantity, etc., has changed in any eBay item you are offering. You can do this easily by setting the fieldgroups URI parameter. This parameter lets you control what is returned in the response. Setting fieldgroups to COMPACT reduces the response to only the five fields that you need in order to check if any item detail has changed. Setting fieldgroups to PRODUCT, adds additional fields to the default response that return information about the product of the item. You can use either COMPACT or PRODUCT but not both. For more information, see fieldgroups. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
post   This method checks if a product is compatible with the specified item. You can use this method to check the compatibility of cars, trucks, and motorcycles with a specific part listed on eBay. For example, to check the compatibility of a part, you pass in the item ID of the part as a URI parameter and specify all the attributes used to define a specific car in the compatibilityProperties container. If the call is successful, the response will be COMPATIBLE, NOT_COMPATIBLE, or UNDETERMINED. See compatibilityStatus for details. Note: The only products supported are cars, trucks, and motorcycles. To find the attributes and values for a specific marketplace, you can use the compatibility methods in the Taxonomy API. You can use this data to create menus to help buyers specify the product, such as their car. For more details and a list of the required attributes for the US marketplace that describe motor vehicles, see Check compatibility in the Buy Integration Guide. For an example, see the Samples section. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/ Note: This method is supported only on Production. Restrictions For a list of supported sites and other restrictions, see API Restrictions.
get   This method searches for eBay items by various query parameters and retrieves summaries of the items. You can search by keyword, category, eBay product ID (ePID), or GTIN, charity ID, or a combination of these. Note: Only FIXED_PRICE (Buy It Now) items are returned by default. However, this method does return items where both FIXED_PRICE and AUCTION are available as a buying option. After a bid has been placed, items become active auction items and are no longer returned by default, but they remain accessible by filtering for the AUCTION buying option. This method also supports the following: Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the filter parameter. Retrieving the refinements (metadata) of an item , such as item aspects (color, brand), condition, category, etc. using the fieldgroups parameter. Filtering by item aspects and other refinements using the aspect_filter parameter. Filtering for items that are compatible with a specific product, using the compatibility_filter parameter. Creating aspects histograms, which enables shoppers to drill down in each refinement narrowing the search results. For details and examples of these capabilities, see Browse API in the Buying Integration Guide. Pagination and sort controls There are pagination controls (limit and offset fields) and sort query parameters that control/sort the data that is returned. By default, the results are sorted by &quot;Best Match&quot;. For more information about Best Match, see the eBay help page Best Match. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item_summary/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item_summary/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
post   This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of the items. You pass in a Base64 image in the request payload and can refine the search by category, or eBay product ID (ePID), or a combination of these using URI parameters. To get the Base64 image string, you can use sites such as https://codebeautify.org/image-to-base64-converter. This method also supports the following: Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the filter parameter. Filtering by item aspects using the aspect_filter parameter. For details and examples of these capabilities, see Browse API in the Buying Integration Guide. Pagination and sort controls There are pagination controls (limit and offset fields) and sort query parameters that control/sort the data that is returned. By default, the results are sorted by &quot;Best Match&quot;. For more information about Best Match, see the eBay help page Best Match. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item_summary/search_by_image/ Sandbox URL: Due to the data available, this method is not supported in the eBay Sandbox. To test your integration, use the Production URL. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. URL Encoding for Parameters Query parameter values need to be URL encoded. For details, see URL encoding query parameter values. For readability, code examples in this document have not been URL encoded. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
get   This is an experimental method. This method retrieves all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. There are no URI parameters or request payload. The response returns the summary details of all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. If the cart is empty, the response is HTTP 204. The quantity and state of an item changes often. If the item becomes &quot;unavailable&quot; such as, when the listing has ended or the item is out of stock, the item will be returned in the unavailableCartItems container. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/shopping_cart/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/ Note: This method is not available in the eBay API Explorer. Restrictions This method can be used only for eBay members. For a list of supported sites and other restrictions, see API Restrictions.
post   This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and adds items to that cart. Because a cart never expires, any item added to the cart will remain in the cart until it is removed. To use this method, you must submit a RESTful item ID and the quantity of the item. If the quantity value is greater than the number of available, the quantity value is changed to the number available and a warning is returned. For example, if there are 15 baseballs available and you set the quantity value to 50, the service automatically changes the value of quantity to 15. The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. The quantity and state of an item changes often. If the item becomes &quot;unavailable&quot; such as, when the listing has ended or the item is out of stock, whether it has just been added to the cart or has been in the cart for some time, the item will be returned in the unavailableCartItems container. Note: There are differences between how legacy APIs, such as Finding, and RESTful APIs, such as Browse, return the identifier of an &quot;item&quot; and what the item ID represents. If you have an item ID from one of the legacy APIs, you can use the legacy item ID with the getItemByLegacyId method to retrieve the RESTful ID for that item. For more information about how to use legacy IDs with the Buy APIs, see Legacy API compatibility in the Buying Integration guide. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/shopping_cart/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/ Note: This method is not available in the eBay API Explorer. Restrictions This method can be used only for eBay members. You can add only items with a FIXED_PRICE that accept PayPal as a payment. For a list of supported sites and other restrictions, see API Restrictions.
delete   This is an experimental method. This method removes a specific item from the eBay member's cart. You specify the ID of the item in the cart (cartItemId) that you want to remove. The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. If you remove the last item in the cart, the response is HTTP 204. The quantity and state of an item changes often. If the item becomes &quot;unavailable&quot; such as, when the listing has ended or the item is out of stock, the item will be returned in the unavailableCartItems container. Note: The cartItemId is not the same as the item ID. The cartItemId is the identifier of a specific item in the cart and is generated when the item was added to the cart. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/shopping_cart/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/ Note: This method is not available in the eBay API Explorer. Restrictions This method can be used only for eBay members. For a list of supported sites and other restrictions, see API Restrictions.
put   This is an experimental method. This method updates the quantity value of a specific item in the eBay member's cart. You specify the ID of the item in the cart (cartItemId) and the new value for the quantity. If the quantity value is greater than the number of available, the quantity value is changed to the number available and a warning is returned. For example, if there are 15 baseballs available and you set the quantity value to 50, the service automatically changes the value of quantity to 15. The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. The quantity and state of an item changes often. If the item becomes &quot;unavailable&quot; such as, the listing has ended or the item is out of stock, the item will be returned in the unavailableCartItems container. Note: The cartItemId is not the same as the item ID. The cartItemId is the identifier of a specific item in the cart and is generated when the item was added to the cart. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/shopping_cart/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/ Note: This method is not available in the eBay API Explorer. Restrictions This method can be used only for eBay members. For a list of supported sites and other restrictions, see API Restrictions.
get   List all active player alliances---Alternate route: `/dev/alliances/`Alternate route: `/legacy/alliances/`Alternate route: `/v1/alliances/`---This route is cached for up to 3600 seconds
get   Public information about an alliance---Alternate route: `/dev/alliances/{alliance_id}/`Alternate route: `/v3/alliances/{alliance_id}/`---This route is cached for up to 3600 seconds
get   Return contacts of an alliance---Alternate route: `/dev/alliances/{alliance_id}/contacts/`Alternate route: `/v2/alliances/{alliance_id}/contacts/`---This route is cached for up to 300 seconds
get   Return custom labels for an alliance's contacts---Alternate route: `/dev/alliances/{alliance_id}/contacts/labels/`Alternate route: `/legacy/alliances/{alliance_id}/contacts/labels/`Alternate route: `/v1/alliances/{alliance_id}/contacts/labels/`---This route is cached for up to 300 seconds
get   List all current member corporations of an alliance---Alternate route: `/dev/alliances/{alliance_id}/corporations/`Alternate route: `/legacy/alliances/{alliance_id}/corporations/`Alternate route: `/v1/alliances/{alliance_id}/corporations/`---This route is cached for up to 3600 seconds
get   Get the icon urls for a alliance---Alternate route: `/dev/alliances/{alliance_id}/icons/`Alternate route: `/legacy/alliances/{alliance_id}/icons/`Alternate route: `/v1/alliances/{alliance_id}/icons/`---This route expires daily at 11:05
post   Bulk lookup of character IDs to corporation, alliance and faction---Alternate route: `/dev/characters/affiliation/`Alternate route: `/legacy/characters/affiliation/`Alternate route: `/v1/characters/affiliation/`---This route is cached for up to 3600 seconds
get   Public information about a character---Alternate route: `/dev/characters/{character_id}/`Alternate route: `/v4/characters/{character_id}/`---This route is cached for up to 3600 seconds
get   Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay * days(currentTime - researchStartDate)---Alternate route: `/dev/characters/{character_id}/agents_research/`Alternate route: `/legacy/characters/{character_id}/agents_research/`Alternate route: `/v1/characters/{character_id}/agents_research/`---This route is cached for up to 3600 seconds
get   Return a list of the characters assets---Alternate route: `/dev/characters/{character_id}/assets/`Alternate route: `/v3/characters/{character_id}/assets/`---This route is cached for up to 3600 seconds
get   Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0)---Alternate route: `/dev/characters/{character_id}/assets/locations/`Alternate route: `/v2/characters/{character_id}/assets/locations/`
get   Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships.---Alternate route: `/dev/characters/{character_id}/assets/names/`Alternate route: `/legacy/characters/{character_id}/assets/names/`Alternate route: `/v1/characters/{character_id}/assets/names/`
get   Return attributes of a character---Alternate route: `/dev/characters/{character_id}/attributes/`Alternate route: `/legacy/characters/{character_id}/attributes/`Alternate route: `/v1/characters/{character_id}/attributes/`---This route is cached for up to 3600 seconds
get   Return a list of blueprints the character owns---Alternate route: `/dev/characters/{character_id}/blueprints/`Alternate route: `/v2/characters/{character_id}/blueprints/`---This route is cached for up to 3600 seconds
get   A list of your character's personal bookmarks---Alternate route: `/dev/characters/{character_id}/bookmarks/`Alternate route: `/v2/characters/{character_id}/bookmarks/`---This route is cached for up to 3600 seconds
get   A list of your character's personal bookmark folders---Alternate route: `/dev/characters/{character_id}/bookmarks/folders/`Alternate route: `/v2/characters/{character_id}/bookmarks/folders/`---This route is cached for up to 3600 seconds
get   Get 50 event summaries from the calendar. If no from_event ID is given, the resource will return the next 50 chronological event summaries from now. If a from_event ID is specified, it will return the next 50 chronological event summaries from after that event---Alternate route: `/dev/characters/{character_id}/calendar/`Alternate route: `/legacy/characters/{character_id}/calendar/`Alternate route: `/v1/characters/{character_id}/calendar/`---This route is cached for up to 5 seconds
get   Get all the information for a specific event---Alternate route: `/dev/characters/{character_id}/calendar/{event_id}/`Alternate route: `/v3/characters/{character_id}/calendar/{event_id}/`---This route is cached for up to 5 seconds
put   Set your response status to an event---Alternate route: `/dev/characters/{character_id}/calendar/{event_id}/`Alternate route: `/v3/characters/{character_id}/calendar/{event_id}/`
get   Get all invited attendees for a given event---Alternate route: `/dev/characters/{character_id}/calendar/{event_id}/attendees/`Alternate route: `/legacy/characters/{character_id}/calendar/{event_id}/attendees/`Alternate route: `/v1/characters/{character_id}/calendar/{event_id}/attendees/`---This route is cached for up to 600 seconds
get   A list of the character's clones---Alternate route: `/dev/characters/{character_id}/clones/`Alternate route: `/v3/characters/{character_id}/clones/`---This route is cached for up to 120 seconds
delete   Bulk delete contacts---Alternate route: `/dev/characters/{character_id}/contacts/`Alternate route: `/v2/characters/{character_id}/contacts/`
get   Return contacts of a character---Alternate route: `/dev/characters/{character_id}/contacts/`Alternate route: `/v2/characters/{character_id}/contacts/`---This route is cached for up to 300 seconds
put   Bulk add contacts with same settings---Alternate route: `/dev/characters/{character_id}/contacts/`Alternate route: `/v2/characters/{character_id}/contacts/`
put   Bulk edit contacts with same settings---Alternate route: `/dev/characters/{character_id}/contacts/`Alternate route: `/v2/characters/{character_id}/contacts/`
get   Return custom labels for a character's contacts---Alternate route: `/dev/characters/{character_id}/contacts/labels/`Alternate route: `/legacy/characters/{character_id}/contacts/labels/`Alternate route: `/v1/characters/{character_id}/contacts/labels/`---This route is cached for up to 300 seconds
get   Returns contracts available to a character, only if the character is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress".---Alternate route: `/dev/characters/{character_id}/contracts/`Alternate route: `/legacy/characters/{character_id}/contracts/`Alternate route: `/v1/characters/{character_id}/contracts/`---This route is cached for up to 300 seconds
get   Lists bids on a particular auction contract---Alternate route: `/dev/characters/{character_id}/contracts/{contract_id}/bids/`Alternate route: `/legacy/characters/{character_id}/contracts/{contract_id}/bids/`Alternate route: `/v1/characters/{character_id}/contracts/{contract_id}/bids/`---This route is cached for up to 300 seconds
get   Lists items of a particular contract---Alternate route: `/dev/characters/{character_id}/contracts/{contract_id}/items/`Alternate route: `/legacy/characters/{character_id}/contracts/{contract_id}/items/`Alternate route: `/v1/characters/{character_id}/contracts/{contract_id}/items/`---This route is cached for up to 3600 seconds
get   Get a list of all the corporations a character has been a member of---Alternate route: `/dev/characters/{character_id}/corporationhistory/`Alternate route: `/legacy/characters/{character_id}/corporationhistory/`Alternate route: `/v1/characters/{character_id}/corporationhistory/`---This route is cached for up to 3600 seconds
invalid   Takes a source character ID in the url and a set of target character ID's in the body, returns a CSPA charge cost---Alternate route: `/dev/characters/{character_id}/cspa/`Alternate route: `/v4/characters/{character_id}/cspa/`
get   Return a character's jump activation and fatigue information---Alternate route: `/dev/characters/{character_id}/fatigue/`Alternate route: `/legacy/characters/{character_id}/fatigue/`Alternate route: `/v1/characters/{character_id}/fatigue/`---This route is cached for up to 300 seconds
get   Return fittings of a character---Alternate route: `/dev/characters/{character_id}/fittings/`Alternate route: `/legacy/characters/{character_id}/fittings/`Alternate route: `/v1/characters/{character_id}/fittings/`---This route is cached for up to 300 seconds
post   Save a new fitting for a character---Alternate route: `/dev/characters/{character_id}/fittings/`Alternate route: `/legacy/characters/{character_id}/fittings/`Alternate route: `/v1/characters/{character_id}/fittings/`
delete   Delete a fitting from a character---Alternate route: `/dev/characters/{character_id}/fittings/{fitting_id}/`Alternate route: `/legacy/characters/{character_id}/fittings/{fitting_id}/`Alternate route: `/v1/characters/{character_id}/fittings/{fitting_id}/`
get   Return the fleet ID the character is in, if any.---Alternate route: `/dev/characters/{character_id}/fleet/`Alternate route: `/legacy/characters/{character_id}/fleet/`Alternate route: `/v1/characters/{character_id}/fleet/`---This route is cached for up to 60 seconds
get   Statistical overview of a character involved in faction warfare---Alternate route: `/dev/characters/{character_id}/fw/stats/`Alternate route: `/legacy/characters/{character_id}/fw/stats/`Alternate route: `/v1/characters/{character_id}/fw/stats/`---This route expires daily at 11:05
get   Return implants on the active clone of a character---Alternate route: `/dev/characters/{character_id}/implants/`Alternate route: `/legacy/characters/{character_id}/implants/`Alternate route: `/v1/characters/{character_id}/implants/`---This route is cached for up to 300 seconds
get   List industry jobs placed by a character---Alternate route: `/dev/characters/{character_id}/industry/jobs/`Alternate route: `/legacy/characters/{character_id}/industry/jobs/`Alternate route: `/v1/characters/{character_id}/industry/jobs/`---This route is cached for up to 300 seconds
get   Return a list of a character's kills and losses going back 90 days---Alternate route: `/dev/characters/{character_id}/killmails/recent/`Alternate route: `/legacy/characters/{character_id}/killmails/recent/`Alternate route: `/v1/characters/{character_id}/killmails/recent/`---This route is cached for up to 300 seconds
get   Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable---Alternate route: `/dev/characters/{character_id}/location/`Alternate route: `/legacy/characters/{character_id}/location/`Alternate route: `/v1/characters/{character_id}/location/`---This route is cached for up to 5 seconds
get   Return a list of loyalty points for all corporations the character has worked for---Alternate route: `/dev/characters/{character_id}/loyalty/points/`Alternate route: `/legacy/characters/{character_id}/loyalty/points/`Alternate route: `/v1/characters/{character_id}/loyalty/points/`---This route is cached for up to 3600 seconds
get   Return the 50 most recent mail headers belonging to the character that match the query criteria. Queries can be filtered by label, and last_mail_id can be used to paginate backwards---Alternate route: `/dev/characters/{character_id}/mail/`Alternate route: `/legacy/characters/{character_id}/mail/`Alternate route: `/v1/characters/{character_id}/mail/`---This route is cached for up to 30 seconds
post   Create and send a new mail---Alternate route: `/dev/characters/{character_id}/mail/`Alternate route: `/legacy/characters/{character_id}/mail/`Alternate route: `/v1/characters/{character_id}/mail/`
get   Return a list of the users mail labels, unread counts for each label and a total unread count.---Alternate route: `/dev/characters/{character_id}/mail/labels/`Alternate route: `/v3/characters/{character_id}/mail/labels/`---This route is cached for up to 30 seconds
post   Create a mail label---Alternate route: `/dev/characters/{character_id}/mail/labels/`Alternate route: `/legacy/characters/{character_id}/mail/labels/`Alternate route: `/v2/characters/{character_id}/mail/labels/`
delete   Delete a mail label---Alternate route: `/dev/characters/{character_id}/mail/labels/{label_id}/`Alternate route: `/legacy/characters/{character_id}/mail/labels/{label_id}/`Alternate route: `/v1/characters/{character_id}/mail/labels/{label_id}/`
get   Return all mailing lists that the character is subscribed to---Alternate route: `/dev/characters/{character_id}/mail/lists/`Alternate route: `/legacy/characters/{character_id}/mail/lists/`Alternate route: `/v1/characters/{character_id}/mail/lists/`---This route is cached for up to 120 seconds
delete   Delete a mail---Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/`Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/`Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/`
get   Return the contents of an EVE mail---Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/`Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/`Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/`---This route is cached for up to 30 seconds
put   Update metadata about a mail---Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/`Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/`Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/`
get   Return a list of medals the character has---Alternate route: `/dev/characters/{character_id}/medals/`Alternate route: `/legacy/characters/{character_id}/medals/`Alternate route: `/v1/characters/{character_id}/medals/`---This route is cached for up to 3600 seconds
get   Paginated record of all mining done by a character for the past 30 days---Alternate route: `/dev/characters/{character_id}/mining/`Alternate route: `/legacy/characters/{character_id}/mining/`Alternate route: `/v1/characters/{character_id}/mining/`---This route is cached for up to 600 seconds
get   Return character notifications---Alternate route: `/dev/characters/{character_id}/notifications/`Alternate route: `/v4/characters/{character_id}/notifications/`---This route is cached for up to 600 seconds
get   Return notifications about having been added to someone's contact list---Alternate route: `/dev/characters/{character_id}/notifications/contacts/`Alternate route: `/legacy/characters/{character_id}/notifications/contacts/`Alternate route: `/v1/characters/{character_id}/notifications/contacts/`---This route is cached for up to 600 seconds
get   Checks if the character is currently online---Alternate route: `/dev/characters/{character_id}/online/`Alternate route: `/v2/characters/{character_id}/online/`---This route is cached for up to 60 seconds
get   Return a list of tasks finished by a character---Alternate route: `/dev/characters/{character_id}/opportunities/`Alternate route: `/legacy/characters/{character_id}/opportunities/`Alternate route: `/v1/characters/{character_id}/opportunities/`---This route is cached for up to 3600 seconds
get   List open market orders placed by a character---Alternate route: `/dev/characters/{character_id}/orders/`Alternate route: `/v2/characters/{character_id}/orders/`---This route is cached for up to 1200 seconds
get   List cancelled and expired market orders placed by a character up to 90 days in the past.---Alternate route: `/dev/characters/{character_id}/orders/history/`Alternate route: `/legacy/characters/{character_id}/orders/history/`Alternate route: `/v1/characters/{character_id}/orders/history/`---This route is cached for up to 3600 seconds
get   Returns a list of all planetary colonies owned by a character.---Alternate route: `/dev/characters/{character_id}/planets/`Alternate route: `/legacy/characters/{character_id}/planets/`Alternate route: `/v1/characters/{character_id}/planets/`---This route is cached for up to 600 seconds
get   Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met.---Alternate route: `/dev/characters/{character_id}/planets/{planet_id}/`Alternate route: `/v3/characters/{character_id}/planets/{planet_id}/`---This route is cached for up to 600 seconds
get   Get portrait urls for a character---Alternate route: `/dev/characters/{character_id}/portrait/`Alternate route: `/v2/characters/{character_id}/portrait/`---This route expires daily at 11:05
get   Returns a character's corporation roles---Alternate route: `/dev/characters/{character_id}/roles/`Alternate route: `/v2/characters/{character_id}/roles/`---This route is cached for up to 3600 seconds
get   Search for entities that match a given sub-string.---Alternate route: `/dev/characters/{character_id}/search/`Alternate route: `/v3/characters/{character_id}/search/`---This route is cached for up to 3600 seconds
get   Get the current ship type, name and id---Alternate route: `/dev/characters/{character_id}/ship/`Alternate route: `/legacy/characters/{character_id}/ship/`Alternate route: `/v1/characters/{character_id}/ship/`---This route is cached for up to 5 seconds
get   List the configured skill queue for the given character---Alternate route: `/dev/characters/{character_id}/skillqueue/`Alternate route: `/legacy/characters/{character_id}/skillqueue/`Alternate route: `/v2/characters/{character_id}/skillqueue/`---This route is cached for up to 120 seconds
get   List all trained skills for the given character---Alternate route: `/dev/characters/{character_id}/skills/`Alternate route: `/v4/characters/{character_id}/skills/`---This route is cached for up to 120 seconds
get   Return character standings from agents, NPC corporations, and factions---Alternate route: `/dev/characters/{character_id}/standings/`Alternate route: `/legacy/characters/{character_id}/standings/`Alternate route: `/v1/characters/{character_id}/standings/`---This route is cached for up to 3600 seconds
get   Returns aggregate yearly stats for a character---Alternate route: `/dev/characters/{character_id}/stats/`Alternate route: `/v2/characters/{character_id}/stats/`---This route is cached for up to 86400 seconds
get   Returns a character's titles---Alternate route: `/dev/characters/{character_id}/titles/`Alternate route: `/legacy/characters/{character_id}/titles/`Alternate route: `/v1/characters/{character_id}/titles/`---This route is cached for up to 3600 seconds
get   Returns a character's wallet balance---Alternate route: `/dev/characters/{character_id}/wallet/`Alternate route: `/legacy/characters/{character_id}/wallet/`Alternate route: `/v1/characters/{character_id}/wallet/`---This route is cached for up to 120 seconds
get   Retrieve the given character's wallet journal going 30 days back---Alternate route: `/legacy/characters/{character_id}/wallet/journal/`Alternate route: `/v4/characters/{character_id}/wallet/journal/`---This route is cached for up to 3600 seconds---Warning: This route has an upgrade available---[Diff of the upcoming changes](https://esi.evetech.net/diff/latest/dev/#GET-/characters/{character_id}/wallet/journal/)
get   Get wallet transactions of a character---Alternate route: `/dev/characters/{character_id}/wallet/transactions/`Alternate route: `/legacy/characters/{character_id}/wallet/transactions/`Alternate route: `/v1/characters/{character_id}/wallet/transactions/`---This route is cached for up to 3600 seconds
get   Lists bids on a public auction contract---Alternate route: `/dev/contracts/public/bids/{contract_id}/`Alternate route: `/legacy/contracts/public/bids/{contract_id}/`Alternate route: `/v1/contracts/public/bids/{contract_id}/`---This route is cached for up to 300 seconds
get   Lists items of a public contract---Alternate route: `/dev/contracts/public/items/{contract_id}/`Alternate route: `/legacy/contracts/public/items/{contract_id}/`Alternate route: `/v1/contracts/public/items/{contract_id}/`---This route is cached for up to 3600 seconds
get   Returns a paginated list of all public contracts in the given region---Alternate route: `/dev/contracts/public/{region_id}/`Alternate route: `/legacy/contracts/public/{region_id}/`Alternate route: `/v1/contracts/public/{region_id}/`---This route is cached for up to 1800 seconds
get   Extraction timers for all moon chunks being extracted by refineries belonging to a corporation.---Alternate route: `/dev/corporation/{corporation_id}/mining/extractions/`Alternate route: `/legacy/corporation/{corporation_id}/mining/extractions/`Alternate route: `/v1/corporation/{corporation_id}/mining/extractions/`---This route is cached for up to 1800 seconds---Requires one of the following EVE corporation role(s): Station_Manager
get   Paginated list of all entities capable of observing and recording mining for a corporation---Alternate route: `/dev/corporation/{corporation_id}/mining/observers/`Alternate route: `/legacy/corporation/{corporation_id}/mining/observers/`Alternate route: `/v1/corporation/{corporation_id}/mining/observers/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Accountant
get   Paginated record of all mining seen by an observer---Alternate route: `/dev/corporation/{corporation_id}/mining/observers/{observer_id}/`Alternate route: `/legacy/corporation/{corporation_id}/mining/observers/{observer_id}/`Alternate route: `/v1/corporation/{corporation_id}/mining/observers/{observer_id}/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Accountant
get   Get a list of npc corporations---Alternate route: `/dev/corporations/npccorps/`Alternate route: `/legacy/corporations/npccorps/`Alternate route: `/v1/corporations/npccorps/`---This route expires daily at 11:05
get   Public information about a corporation---Alternate route: `/dev/corporations/{corporation_id}/`Alternate route: `/v4/corporations/{corporation_id}/`---This route is cached for up to 3600 seconds
get   Get a list of all the alliances a corporation has been a member of---Alternate route: `/dev/corporations/{corporation_id}/alliancehistory/`Alternate route: `/v2/corporations/{corporation_id}/alliancehistory/`---This route is cached for up to 3600 seconds
get   Return a list of the corporation assets---Alternate route: `/dev/corporations/{corporation_id}/assets/`Alternate route: `/v3/corporations/{corporation_id}/assets/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Return locations for a set of item ids, which you can get from corporation assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0)---Alternate route: `/dev/corporations/{corporation_id}/assets/locations/`Alternate route: `/v2/corporations/{corporation_id}/assets/locations/`---Requires one of the following EVE corporation role(s): Director
get   Return names for a set of item ids, which you can get from corporation assets endpoint. Only valid for items that can customize names, like containers or ships---Alternate route: `/dev/corporations/{corporation_id}/assets/names/`Alternate route: `/legacy/corporations/{corporation_id}/assets/names/`Alternate route: `/v1/corporations/{corporation_id}/assets/names/`---Requires one of the following EVE corporation role(s): Director
get   Returns a list of blueprints the corporation owns---Alternate route: `/dev/corporations/{corporation_id}/blueprints/`Alternate route: `/v2/corporations/{corporation_id}/blueprints/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   A list of your corporation's bookmarks---Alternate route: `/dev/corporations/{corporation_id}/bookmarks/`Alternate route: `/legacy/corporations/{corporation_id}/bookmarks/`Alternate route: `/v1/corporations/{corporation_id}/bookmarks/`---This route is cached for up to 3600 seconds
get   A list of your corporation's bookmark folders---Alternate route: `/dev/corporations/{corporation_id}/bookmarks/folders/`Alternate route: `/legacy/corporations/{corporation_id}/bookmarks/folders/`Alternate route: `/v1/corporations/{corporation_id}/bookmarks/folders/`---This route is cached for up to 3600 seconds
get   Return contacts of a corporation---Alternate route: `/dev/corporations/{corporation_id}/contacts/`Alternate route: `/v2/corporations/{corporation_id}/contacts/`---This route is cached for up to 300 seconds
get   Return custom labels for a corporation's contacts---Alternate route: `/dev/corporations/{corporation_id}/contacts/labels/`Alternate route: `/legacy/corporations/{corporation_id}/contacts/labels/`Alternate route: `/v1/corporations/{corporation_id}/contacts/labels/`---This route is cached for up to 300 seconds
get   Returns logs recorded in the past seven days from all audit log secure containers (ALSC) owned by a given corporation---Alternate route: `/dev/corporations/{corporation_id}/containers/logs/`Alternate route: `/v2/corporations/{corporation_id}/containers/logs/`---This route is cached for up to 600 seconds---Requires one of the following EVE corporation role(s): Director
get   Returns contracts available to a corporation, only if the corporation is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress".---Alternate route: `/dev/corporations/{corporation_id}/contracts/`Alternate route: `/legacy/corporations/{corporation_id}/contracts/`Alternate route: `/v1/corporations/{corporation_id}/contracts/`---This route is cached for up to 300 seconds
get   Lists bids on a particular auction contract---Alternate route: `/dev/corporations/{corporation_id}/contracts/{contract_id}/bids/`Alternate route: `/legacy/corporations/{corporation_id}/contracts/{contract_id}/bids/`Alternate route: `/v1/corporations/{corporation_id}/contracts/{contract_id}/bids/`---This route is cached for up to 3600 seconds
get   Lists items of a particular contract---Alternate route: `/dev/corporations/{corporation_id}/contracts/{contract_id}/items/`Alternate route: `/legacy/corporations/{corporation_id}/contracts/{contract_id}/items/`Alternate route: `/v1/corporations/{corporation_id}/contracts/{contract_id}/items/`---This route is cached for up to 3600 seconds
get   List customs offices owned by a corporation---Alternate route: `/dev/corporations/{corporation_id}/customs_offices/`Alternate route: `/legacy/corporations/{corporation_id}/customs_offices/`Alternate route: `/v1/corporations/{corporation_id}/customs_offices/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Return corporation hangar and wallet division names, only show if a division is not using the default name---Alternate route: `/dev/corporations/{corporation_id}/divisions/`Alternate route: `/legacy/corporations/{corporation_id}/divisions/`Alternate route: `/v1/corporations/{corporation_id}/divisions/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Return a corporation's facilities---Alternate route: `/dev/corporations/{corporation_id}/facilities/`Alternate route: `/legacy/corporations/{corporation_id}/facilities/`Alternate route: `/v1/corporations/{corporation_id}/facilities/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Factory_Manager
get   Statistics about a corporation involved in faction warfare---Alternate route: `/dev/corporations/{corporation_id}/fw/stats/`Alternate route: `/legacy/corporations/{corporation_id}/fw/stats/`Alternate route: `/v1/corporations/{corporation_id}/fw/stats/`---This route expires daily at 11:05
get   Get the icon urls for a corporation---Alternate route: `/dev/corporations/{corporation_id}/icons/`Alternate route: `/legacy/corporations/{corporation_id}/icons/`Alternate route: `/v1/corporations/{corporation_id}/icons/`---This route is cached for up to 3600 seconds
get   List industry jobs run by a corporation---Alternate route: `/dev/corporations/{corporation_id}/industry/jobs/`Alternate route: `/legacy/corporations/{corporation_id}/industry/jobs/`Alternate route: `/v1/corporations/{corporation_id}/industry/jobs/`---This route is cached for up to 300 seconds---Requires one of the following EVE corporation role(s): Factory_Manager
get   Get a list of a corporation's kills and losses going back 90 days---Alternate route: `/dev/corporations/{corporation_id}/killmails/recent/`Alternate route: `/legacy/corporations/{corporation_id}/killmails/recent/`Alternate route: `/v1/corporations/{corporation_id}/killmails/recent/`---This route is cached for up to 300 seconds---Requires one of the following EVE corporation role(s): Director
get   Returns a corporation's medals---Alternate route: `/dev/corporations/{corporation_id}/medals/`Alternate route: `/legacy/corporations/{corporation_id}/medals/`Alternate route: `/v1/corporations/{corporation_id}/medals/`---This route is cached for up to 3600 seconds
get   Returns medals issued by a corporation---Alternate route: `/dev/corporations/{corporation_id}/medals/issued/`Alternate route: `/legacy/corporations/{corporation_id}/medals/issued/`Alternate route: `/v1/corporations/{corporation_id}/medals/issued/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Return the current member list of a corporation, the token's character need to be a member of the corporation.---Alternate route: `/dev/corporations/{corporation_id}/members/`Alternate route: `/v3/corporations/{corporation_id}/members/`---This route is cached for up to 3600 seconds
get   Return a corporation's member limit, not including CEO himself---Alternate route: `/dev/corporations/{corporation_id}/members/limit/`Alternate route: `/legacy/corporations/{corporation_id}/members/limit/`Alternate route: `/v1/corporations/{corporation_id}/members/limit/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Returns a corporation's members' titles---Alternate route: `/dev/corporations/{corporation_id}/members/titles/`Alternate route: `/legacy/corporations/{corporation_id}/members/titles/`Alternate route: `/v1/corporations/{corporation_id}/members/titles/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Returns additional information about a corporation's members which helps tracking their activities---Alternate route: `/dev/corporations/{corporation_id}/membertracking/`Alternate route: `/legacy/corporations/{corporation_id}/membertracking/`Alternate route: `/v1/corporations/{corporation_id}/membertracking/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   List open market orders placed on behalf of a corporation---Alternate route: `/dev/corporations/{corporation_id}/orders/`Alternate route: `/v3/corporations/{corporation_id}/orders/`---This route is cached for up to 1200 seconds---Requires one of the following EVE corporation role(s): Accountant, Trader
get   List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past.---Alternate route: `/dev/corporations/{corporation_id}/orders/history/`Alternate route: `/v2/corporations/{corporation_id}/orders/history/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Accountant, Trader
get   Return the roles of all members if the character has the personnel manager role or any grantable role.---Alternate route: `/dev/corporations/{corporation_id}/roles/`Alternate route: `/legacy/corporations/{corporation_id}/roles/`Alternate route: `/v1/corporations/{corporation_id}/roles/`---This route is cached for up to 3600 seconds
get   Return how roles have changed for a coporation's members, up to a month---Alternate route: `/dev/corporations/{corporation_id}/roles/history/`Alternate route: `/legacy/corporations/{corporation_id}/roles/history/`Alternate route: `/v1/corporations/{corporation_id}/roles/history/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Return the current shareholders of a corporation.---Alternate route: `/dev/corporations/{corporation_id}/shareholders/`Alternate route: `/legacy/corporations/{corporation_id}/shareholders/`Alternate route: `/v1/corporations/{corporation_id}/shareholders/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Return corporation standings from agents, NPC corporations, and factions---Alternate route: `/dev/corporations/{corporation_id}/standings/`Alternate route: `/legacy/corporations/{corporation_id}/standings/`Alternate route: `/v1/corporations/{corporation_id}/standings/`---This route is cached for up to 3600 seconds
get   Returns list of corporation starbases (POSes)---Alternate route: `/dev/corporations/{corporation_id}/starbases/`Alternate route: `/legacy/corporations/{corporation_id}/starbases/`Alternate route: `/v1/corporations/{corporation_id}/starbases/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Returns various settings and fuels of a starbase (POS)---Alternate route: `/dev/corporations/{corporation_id}/starbases/{starbase_id}/`Alternate route: `/legacy/corporations/{corporation_id}/starbases/{starbase_id}/`Alternate route: `/v1/corporations/{corporation_id}/starbases/{starbase_id}/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Get a list of corporation structures. This route's version includes the changes to structures detailed in this blog: https://www.eveonline.com/article/upwell-2.0-structures-changes-coming-on-february-13th Note: this route will not return any flex structures owned by a corporation, use the v3 route to have those included in the response. A list of FLEX structures can be found here: https://support.eveonline.com/hc/en-us/articles/213021829-Upwell-Structures---Alternate route: `/v2/corporations/{corporation_id}/structures/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Station_Manager---Warning: This route has an upgrade available---[Diff of the upcoming changes](https://esi.evetech.net/diff/latest/dev/#GET-/corporations/{corporation_id}/structures/)
get   Returns a corporation's titles---Alternate route: `/dev/corporations/{corporation_id}/titles/`Alternate route: `/legacy/corporations/{corporation_id}/titles/`Alternate route: `/v1/corporations/{corporation_id}/titles/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Get a corporation's wallets---Alternate route: `/dev/corporations/{corporation_id}/wallets/`Alternate route: `/legacy/corporations/{corporation_id}/wallets/`Alternate route: `/v1/corporations/{corporation_id}/wallets/`---This route is cached for up to 300 seconds---Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant
get   Retrieve the given corporation's wallet journal for the given division going 30 days back. Note: any journal records having to do with the new navigation structures from the release of Onslaught will not show up in this version. To see those, use the v4 version of this route.---Alternate route: `/legacy/corporations/{corporation_id}/wallets/{division}/journal/`Alternate route: `/v3/corporations/{corporation_id}/wallets/{division}/journal/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant---Warning: This route has an upgrade available---[Diff of the upcoming changes](https://esi.evetech.net/diff/latest/dev/#GET-/corporations/{corporation_id}/wallets/{division}/journal/)
get   Get wallet transactions of a corporation---Alternate route: `/dev/corporations/{corporation_id}/wallets/{division}/transactions/`Alternate route: `/legacy/corporations/{corporation_id}/wallets/{division}/transactions/`Alternate route: `/v1/corporations/{corporation_id}/wallets/{division}/transactions/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant
get   Get a list of dogma attribute ids---Alternate route: `/dev/dogma/attributes/`Alternate route: `/legacy/dogma/attributes/`Alternate route: `/v1/dogma/attributes/`---This route expires daily at 11:05
get   Get information on a dogma attribute---Alternate route: `/dev/dogma/attributes/{attribute_id}/`Alternate route: `/legacy/dogma/attributes/{attribute_id}/`Alternate route: `/v1/dogma/attributes/{attribute_id}/`---This route expires daily at 11:05
get   Returns info about a dynamic item resulting from mutation with a mutaplasmid.---Alternate route: `/dev/dogma/dynamic/items/{type_id}/{item_id}/`Alternate route: `/legacy/dogma/dynamic/items/{type_id}/{item_id}/`Alternate route: `/v1/dogma/dynamic/items/{type_id}/{item_id}/`---This route expires daily at 11:05
get   Get a list of dogma effect ids---Alternate route: `/dev/dogma/effects/`Alternate route: `/legacy/dogma/effects/`Alternate route: `/v1/dogma/effects/`---This route expires daily at 11:05
get   Get information on a dogma effect---Alternate route: `/dev/dogma/effects/{effect_id}/`Alternate route: `/v2/dogma/effects/{effect_id}/`---This route expires daily at 11:05
get   Return details about a fleet---Alternate route: `/dev/fleets/{fleet_id}/`Alternate route: `/legacy/fleets/{fleet_id}/`Alternate route: `/v1/fleets/{fleet_id}/`---This route is cached for up to 5 seconds
put   Update settings about a fleet---Alternate route: `/dev/fleets/{fleet_id}/`Alternate route: `/legacy/fleets/{fleet_id}/`Alternate route: `/v1/fleets/{fleet_id}/`
get   Return information about fleet members---Alternate route: `/dev/fleets/{fleet_id}/members/`Alternate route: `/legacy/fleets/{fleet_id}/members/`Alternate route: `/v1/fleets/{fleet_id}/members/`---This route is cached for up to 5 seconds
post   Invite a character into the fleet. If a character has a CSPA charge set it is not possible to invite them to the fleet using ESI---Alternate route: `/dev/fleets/{fleet_id}/members/`Alternate route: `/legacy/fleets/{fleet_id}/members/`Alternate route: `/v1/fleets/{fleet_id}/members/`
delete   Kick a fleet member---Alternate route: `/dev/fleets/{fleet_id}/members/{member_id}/`Alternate route: `/legacy/fleets/{fleet_id}/members/{member_id}/`Alternate route: `/v1/fleets/{fleet_id}/members/{member_id}/`
post   Move a fleet member around---Alternate route: `/dev/fleets/{fleet_id}/members/{member_id}/`Alternate route: `/legacy/fleets/{fleet_id}/members/{member_id}/`Alternate route: `/v1/fleets/{fleet_id}/members/{member_id}/`
delete   Delete a fleet squad, only empty squads can be deleted---Alternate route: `/dev/fleets/{fleet_id}/squads/{squad_id}/`Alternate route: `/legacy/fleets/{fleet_id}/squads/{squad_id}/`Alternate route: `/v1/fleets/{fleet_id}/squads/{squad_id}/`
post   Rename a fleet squad---Alternate route: `/dev/fleets/{fleet_id}/squads/{squad_id}/`Alternate route: `/legacy/fleets/{fleet_id}/squads/{squad_id}/`Alternate route: `/v1/fleets/{fleet_id}/squads/{squad_id}/`
get   Return information about wings in a fleet---Alternate route: `/dev/fleets/{fleet_id}/wings/`Alternate route: `/legacy/fleets/{fleet_id}/wings/`Alternate route: `/v1/fleets/{fleet_id}/wings/`---This route is cached for up to 5 seconds
post   Create a new wing in a fleet---Alternate route: `/dev/fleets/{fleet_id}/wings/`Alternate route: `/legacy/fleets/{fleet_id}/wings/`Alternate route: `/v1/fleets/{fleet_id}/wings/`
delete   Delete a fleet wing, only empty wings can be deleted. The wing may contain squads, but the squads must be empty---Alternate route: `/dev/fleets/{fleet_id}/wings/{wing_id}/`Alternate route: `/legacy/fleets/{fleet_id}/wings/{wing_id}/`Alternate route: `/v1/fleets/{fleet_id}/wings/{wing_id}/`
post   Rename a fleet wing---Alternate route: `/dev/fleets/{fleet_id}/wings/{wing_id}/`Alternate route: `/legacy/fleets/{fleet_id}/wings/{wing_id}/`Alternate route: `/v1/fleets/{fleet_id}/wings/{wing_id}/`
post   Create a new squad in a fleet---Alternate route: `/dev/fleets/{fleet_id}/wings/{wing_id}/squads/`Alternate route: `/legacy/fleets/{fleet_id}/wings/{wing_id}/squads/`Alternate route: `/v1/fleets/{fleet_id}/wings/{wing_id}/squads/`
get   Top 4 leaderboard of factions for kills and victory points separated by total, last week and yesterday---Alternate route: `/dev/fw/leaderboards/`Alternate route: `/legacy/fw/leaderboards/`Alternate route: `/v1/fw/leaderboards/`---This route expires daily at 11:05
get   Top 100 leaderboard of pilots for kills and victory points separated by total, last week and yesterday---Alternate route: `/dev/fw/leaderboards/characters/`Alternate route: `/legacy/fw/leaderboards/characters/`Alternate route: `/v1/fw/leaderboards/characters/`---This route expires daily at 11:05
get   Top 10 leaderboard of corporations for kills and victory points separated by total, last week and yesterday---Alternate route: `/dev/fw/leaderboards/corporations/`Alternate route: `/legacy/fw/leaderboards/corporations/`Alternate route: `/v1/fw/leaderboards/corporations/`---This route expires daily at 11:05
get   Statistical overviews of factions involved in faction warfare---Alternate route: `/dev/fw/stats/`Alternate route: `/legacy/fw/stats/`Alternate route: `/v1/fw/stats/`---This route expires daily at 11:05
get   An overview of the current ownership of faction warfare solar systems---Alternate route: `/dev/fw/systems/`Alternate route: `/v2/fw/systems/`---This route is cached for up to 1800 seconds
get   Data about which NPC factions are at war---Alternate route: `/dev/fw/wars/`Alternate route: `/legacy/fw/wars/`Alternate route: `/v1/fw/wars/`---This route expires daily at 11:05
get   Return a list of current incursions---Alternate route: `/dev/incursions/`Alternate route: `/legacy/incursions/`Alternate route: `/v1/incursions/`---This route is cached for up to 300 seconds
get   Return a list of industry facilities---Alternate route: `/dev/industry/facilities/`Alternate route: `/legacy/industry/facilities/`Alternate route: `/v1/industry/facilities/`---This route is cached for up to 3600 seconds
get   Return cost indices for solar systems---Alternate route: `/dev/industry/systems/`Alternate route: `/legacy/industry/systems/`Alternate route: `/v1/industry/systems/`---This route is cached for up to 3600 seconds
get   Return available insurance levels for all ship types---Alternate route: `/dev/insurance/prices/`Alternate route: `/legacy/insurance/prices/`Alternate route: `/v1/insurance/prices/`---This route is cached for up to 3600 seconds
get   Return a single killmail from its ID and hash---Alternate route: `/dev/killmails/{killmail_id}/{killmail_hash}/`Alternate route: `/legacy/killmails/{killmail_id}/{killmail_hash}/`Alternate route: `/v1/killmails/{killmail_id}/{killmail_hash}/`---This route is cached for up to 1209600 seconds
get   Return a list of offers from a specific corporation's loyalty store---Alternate route: `/dev/loyalty/stores/{corporation_id}/offers/`Alternate route: `/legacy/loyalty/stores/{corporation_id}/offers/`Alternate route: `/v1/loyalty/stores/{corporation_id}/offers/`---This route expires daily at 11:05
get   Get a list of item groups---Alternate route: `/dev/markets/groups/`Alternate route: `/legacy/markets/groups/`Alternate route: `/v1/markets/groups/`---This route expires daily at 11:05
get   Get information on an item group---Alternate route: `/dev/markets/groups/{market_group_id}/`Alternate route: `/legacy/markets/groups/{market_group_id}/`Alternate route: `/v1/markets/groups/{market_group_id}/`---This route expires daily at 11:05
get   Return a list of prices---Alternate route: `/dev/markets/prices/`Alternate route: `/legacy/markets/prices/`Alternate route: `/v1/markets/prices/`---This route is cached for up to 3600 seconds
get   Return all orders in a structure---Alternate route: `/dev/markets/structures/{structure_id}/`Alternate route: `/legacy/markets/structures/{structure_id}/`Alternate route: `/v1/markets/structures/{structure_id}/`---This route is cached for up to 300 seconds
get   Return a list of historical market statistics for the specified type in a region---Alternate route: `/dev/markets/{region_id}/history/`Alternate route: `/legacy/markets/{region_id}/history/`Alternate route: `/v1/markets/{region_id}/history/`---This route expires daily at 11:05
get   Return a list of orders in a region---Alternate route: `/dev/markets/{region_id}/orders/`Alternate route: `/legacy/markets/{region_id}/orders/`Alternate route: `/v1/markets/{region_id}/orders/`---This route is cached for up to 300 seconds
get   Return a list of type IDs that have active orders in the region, for efficient market indexing.---Alternate route: `/dev/markets/{region_id}/types/`Alternate route: `/legacy/markets/{region_id}/types/`Alternate route: `/v1/markets/{region_id}/types/`---This route is cached for up to 600 seconds
get   Return a list of opportunities groups---Alternate route: `/dev/opportunities/groups/`Alternate route: `/legacy/opportunities/groups/`Alternate route: `/v1/opportunities/groups/`---This route expires daily at 11:05
get   Return information of an opportunities group---Alternate route: `/dev/opportunities/groups/{group_id}/`Alternate route: `/legacy/opportunities/groups/{group_id}/`Alternate route: `/v1/opportunities/groups/{group_id}/`---This route expires daily at 11:05
get   Return a list of opportunities tasks---Alternate route: `/dev/opportunities/tasks/`Alternate route: `/legacy/opportunities/tasks/`Alternate route: `/v1/opportunities/tasks/`---This route expires daily at 11:05
get   Return information of an opportunities task---Alternate route: `/dev/opportunities/tasks/{task_id}/`Alternate route: `/legacy/opportunities/tasks/{task_id}/`Alternate route: `/v1/opportunities/tasks/{task_id}/`---This route expires daily at 11:05
get   Get the systems between origin and destination---Alternate route: `/dev/route/{origin}/{destination}/`Alternate route: `/legacy/route/{origin}/{destination}/`Alternate route: `/v1/route/{origin}/{destination}/`---This route is cached for up to 86400 seconds
get   Search for entities that match a given sub-string.---Alternate route: `/dev/search/`Alternate route: `/v2/search/`---This route is cached for up to 3600 seconds
get   Shows sovereignty data for campaigns.---Alternate route: `/dev/sovereignty/campaigns/`Alternate route: `/legacy/sovereignty/campaigns/`Alternate route: `/v1/sovereignty/campaigns/`---This route is cached for up to 5 seconds
get   Shows sovereignty information for solar systems---Alternate route: `/dev/sovereignty/map/`Alternate route: `/legacy/sovereignty/map/`Alternate route: `/v1/sovereignty/map/`---This route is cached for up to 3600 seconds
get   Shows sovereignty data for structures.---Alternate route: `/dev/sovereignty/structures/`Alternate route: `/legacy/sovereignty/structures/`Alternate route: `/v1/sovereignty/structures/`---This route is cached for up to 120 seconds
get   EVE Server status---Alternate route: `/dev/status/`Alternate route: `/legacy/status/`Alternate route: `/v1/status/`---This route is cached for up to 30 seconds
put   Set a solar system as autopilot waypoint---Alternate route: `/dev/ui/autopilot/waypoint/`Alternate route: `/v2/ui/autopilot/waypoint/`
post   Open the contract window inside the client---Alternate route: `/dev/ui/openwindow/contract/`Alternate route: `/legacy/ui/openwindow/contract/`Alternate route: `/v1/ui/openwindow/contract/`
post   Open the information window for a character, corporation or alliance inside the client---Alternate route: `/dev/ui/openwindow/information/`Alternate route: `/legacy/ui/openwindow/information/`Alternate route: `/v1/ui/openwindow/information/`
post   Open the market details window for a specific typeID inside the client---Alternate route: `/dev/ui/openwindow/marketdetails/`Alternate route: `/legacy/ui/openwindow/marketdetails/`Alternate route: `/v1/ui/openwindow/marketdetails/`
post   Open the New Mail window, according to settings from the request if applicable---Alternate route: `/dev/ui/openwindow/newmail/`Alternate route: `/legacy/ui/openwindow/newmail/`Alternate route: `/v1/ui/openwindow/newmail/`
get   Get all character ancestries---Alternate route: `/dev/universe/ancestries/`Alternate route: `/legacy/universe/ancestries/`Alternate route: `/v1/universe/ancestries/`---This route expires daily at 11:05
get   Get information on an asteroid belt---Alternate route: `/dev/universe/asteroid_belts/{asteroid_belt_id}/`Alternate route: `/legacy/universe/asteroid_belts/{asteroid_belt_id}/`Alternate route: `/v1/universe/asteroid_belts/{asteroid_belt_id}/`---This route expires daily at 11:05
get   Get a list of bloodlines---Alternate route: `/dev/universe/bloodlines/`Alternate route: `/legacy/universe/bloodlines/`Alternate route: `/v1/universe/bloodlines/`---This route expires daily at 11:05
get   Get a list of item categories---Alternate route: `/dev/universe/categories/`Alternate route: `/legacy/universe/categories/`Alternate route: `/v1/universe/categories/`---This route expires daily at 11:05
get   Get information of an item category---Alternate route: `/dev/universe/categories/{category_id}/`Alternate route: `/legacy/universe/categories/{category_id}/`Alternate route: `/v1/universe/categories/{category_id}/`---This route expires daily at 11:05
get   Get a list of constellations---Alternate route: `/dev/universe/constellations/`Alternate route: `/legacy/universe/constellations/`Alternate route: `/v1/universe/constellations/`---This route expires daily at 11:05
get   Get information on a constellation---Alternate route: `/dev/universe/constellations/{constellation_id}/`Alternate route: `/legacy/universe/constellations/{constellation_id}/`Alternate route: `/v1/universe/constellations/{constellation_id}/`---This route expires daily at 11:05
get   Get a list of factions---Alternate route: `/dev/universe/factions/`Alternate route: `/v2/universe/factions/`---This route expires daily at 11:05
get   Get a list of graphics---Alternate route: `/dev/universe/graphics/`Alternate route: `/legacy/universe/graphics/`Alternate route: `/v1/universe/graphics/`---This route expires daily at 11:05
get   Get information on a graphic---Alternate route: `/dev/universe/graphics/{graphic_id}/`Alternate route: `/legacy/universe/graphics/{graphic_id}/`Alternate route: `/v1/universe/graphics/{graphic_id}/`---This route expires daily at 11:05
get   Get a list of item groups---Alternate route: `/dev/universe/groups/`Alternate route: `/legacy/universe/groups/`Alternate route: `/v1/universe/groups/`---This route expires daily at 11:05
get   Get information on an item group---Alternate route: `/dev/universe/groups/{group_id}/`Alternate route: `/legacy/universe/groups/{group_id}/`Alternate route: `/v1/universe/groups/{group_id}/`---This route expires daily at 11:05
post   Resolve a set of names to IDs in the following categories: agents, alliances, characters, constellations, corporations factions, inventory_types, regions, stations, and systems. Only exact matches will be returned. All names searched for are cached for 12 hours---Alternate route: `/dev/universe/ids/`Alternate route: `/legacy/universe/ids/`Alternate route: `/v1/universe/ids/`
get   Get information on a moon---Alternate route: `/dev/universe/moons/{moon_id}/`Alternate route: `/legacy/universe/moons/{moon_id}/`Alternate route: `/v1/universe/moons/{moon_id}/`---This route expires daily at 11:05
post   Resolve a set of IDs to names and categories. Supported ID's for resolving are: Characters, Corporations, Alliances, Stations, Solar Systems, Constellations, Regions, Types---Alternate route: `/dev/universe/names/`Alternate route: `/v2/universe/names/`
get   Get information on a planet---Alternate route: `/dev/universe/planets/{planet_id}/`Alternate route: `/legacy/universe/planets/{planet_id}/`Alternate route: `/v1/universe/planets/{planet_id}/`---This route expires daily at 11:05
get   Get a list of character races---Alternate route: `/dev/universe/races/`Alternate route: `/legacy/universe/races/`Alternate route: `/v1/universe/races/`---This route expires daily at 11:05
get   Get a list of regions---Alternate route: `/dev/universe/regions/`Alternate route: `/legacy/universe/regions/`Alternate route: `/v1/universe/regions/`---This route expires daily at 11:05
get   Get information on a region---Alternate route: `/dev/universe/regions/{region_id}/`Alternate route: `/legacy/universe/regions/{region_id}/`Alternate route: `/v1/universe/regions/{region_id}/`---This route expires daily at 11:05
get   Get information on a planetary factory schematic---Alternate route: `/dev/universe/schematics/{schematic_id}/`Alternate route: `/legacy/universe/schematics/{schematic_id}/`Alternate route: `/v1/universe/schematics/{schematic_id}/`---This route is cached for up to 3600 seconds
get   Get information on a stargate---Alternate route: `/dev/universe/stargates/{stargate_id}/`Alternate route: `/legacy/universe/stargates/{stargate_id}/`Alternate route: `/v1/universe/stargates/{stargate_id}/`---This route expires daily at 11:05
get   Get information on a star---Alternate route: `/dev/universe/stars/{star_id}/`Alternate route: `/legacy/universe/stars/{star_id}/`Alternate route: `/v1/universe/stars/{star_id}/`---This route expires daily at 11:05
get   Get information on a station---Alternate route: `/dev/universe/stations/{station_id}/`Alternate route: `/v2/universe/stations/{station_id}/`---This route expires daily at 11:05
get   List all public structures---Alternate route: `/dev/universe/structures/`Alternate route: `/legacy/universe/structures/`Alternate route: `/v1/universe/structures/`---This route is cached for up to 3600 seconds
get   Returns information on requested structure if you are on the ACL. Otherwise, returns "Forbidden" for all inputs.---Alternate route: `/dev/universe/structures/{structure_id}/`Alternate route: `/v2/universe/structures/{structure_id}/`---This route is cached for up to 3600 seconds
get   Get the number of jumps in solar systems within the last hour ending at the timestamp of the Last-Modified header, excluding wormhole space. Only systems with jumps will be listed---Alternate route: `/dev/universe/system_jumps/`Alternate route: `/legacy/universe/system_jumps/`Alternate route: `/v1/universe/system_jumps/`---This route is cached for up to 3600 seconds
get   Get the number of ship, pod and NPC kills per solar system within the last hour ending at the timestamp of the Last-Modified header, excluding wormhole space. Only systems with kills will be listed---Alternate route: `/dev/universe/system_kills/`Alternate route: `/v2/universe/system_kills/`---This route is cached for up to 3600 seconds
get   Get a list of solar systems---Alternate route: `/dev/universe/systems/`Alternate route: `/legacy/universe/systems/`Alternate route: `/v1/universe/systems/`---This route expires daily at 11:05
get   Get information on a solar system.---Alternate route: `/dev/universe/systems/{system_id}/`Alternate route: `/v4/universe/systems/{system_id}/`---This route expires daily at 11:05
get   Get a list of type ids---Alternate route: `/dev/universe/types/`Alternate route: `/legacy/universe/types/`Alternate route: `/v1/universe/types/`---This route expires daily at 11:05
get   Get information on a type---Alternate route: `/dev/universe/types/{type_id}/`Alternate route: `/v3/universe/types/{type_id}/`---This route expires daily at 11:05
get   Return a list of wars---Alternate route: `/dev/wars/`Alternate route: `/legacy/wars/`Alternate route: `/v1/wars/`---This route is cached for up to 3600 seconds
get   Return details about a war---Alternate route: `/dev/wars/{war_id}/`Alternate route: `/legacy/wars/{war_id}/`Alternate route: `/v1/wars/{war_id}/`---This route is cached for up to 3600 seconds
get   Return a list of kills related to a war---Alternate route: `/dev/wars/{war_id}/killmails/`Alternate route: `/legacy/wars/{war_id}/killmails/`Alternate route: `/v1/wars/{war_id}/killmails/`---This route is cached for up to 3600 seconds
invalid   Create and update symbol List
invalid   Get and delete a symbol list referring to one item.
invalid   Get and update a symbol list referring to one item.
invalid   Get and create a symbol list referring to one item.
invalid   Get and rename a symbol list referring to one item.
get   This method retrieves the details of specific items that the buyer needs to make a purchasing decision. Note: This is a (Limited Release) available only to select Partners. For this method, only the following fields are returned: eligibleForInlineCheckout, estimatedAvailabilities, itemAffiliateWebURL, itemID, ItemWebURL, legacyItemID, price, sellerItemRevision, and topRatedBuyingExperience. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
get   This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Buy APIs. There are differences between how legacy APIs and RESTful APIs return the identifier of an &quot;item&quot; and what the item ID represents. This method lets you use the legacy item ids retrieve the details of a specific item, such as description, price, and other information the buyer needs to make a purchasing decision. It also returns the RESTful item ID, which you can use with all the Buy API methods. For more information about how to use legacy ids with the Buy APIs, see Legacy API compatibility in the Buying Integration guide. This method returns the item details and requires you to pass in either the item ID of a non-variation item or the item ids of both the parent and child of an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the &quot;parent&quot;. All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc. The fieldgroups URI parameter lets you control what is returned in the response. Setting fieldgroups to PRODUCT, adds additional fields to the default response that return information about the product of the item. For more information, see fieldgroups. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/get_item_by_legacy_id/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/get_item_by_legacy_id/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
get   This method retrieves the details of the individual items in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. You pass in the item group ID as a URI parameter. You use this method to show the item details of items with multiple aspects, such as color, size, storage capacity, etc. This method returns two main containers; items and commonDescriptions. The items container has an array of containers with the details of each item in the group. The commonDescriptions container has an array of containers for a description and the item ids of all the items that have this exact description. Because items within an item group often have the same description, this decreases the size of the response. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/get_items_by_item_group/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
get   This method retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery, and other information the buyer needs to make a purchasing decision. The Buy APIs are designed to let you create an eBay shopping experience in your app or website. This means you will need to know when something, such as the availability, quantity, etc., has changed in any eBay item you are offering. You can do this easily by setting the fieldgroups URI parameter. This parameter lets you control what is returned in the response. Setting fieldgroups to COMPACT reduces the response to only the five fields that you need in order to check if any item detail has changed. Setting fieldgroups to PRODUCT, adds additional fields to the default response that return information about the product of the item. You can use either COMPACT or PRODUCT but not both. For more information, see fieldgroups. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
post   This method checks if a product is compatible with the specified item. You can use this method to check the compatibility of cars, trucks, and motorcycles with a specific part listed on eBay. For example, to check the compatibility of a part, you pass in the item ID of the part as a URI parameter and specify all the attributes used to define a specific car in the compatibilityProperties container. If the call is successful, the response will be COMPATIBLE, NOT_COMPATIBLE, or UNDETERMINED. See compatibilityStatus for details. Note: The only products supported are cars, trucks, and motorcycles. To find the attributes and values for a specific marketplace, you can use the compatibility methods in the Taxonomy API. You can use this data to create menus to help buyers specify the product, such as their car. For more details and a list of the required attributes for the US marketplace that describe motor vehicles, see Check compatibility in the Buy Integration Guide. For an example, see the Samples section. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/ Note: This method is supported only on Production. Restrictions For a list of supported sites and other restrictions, see API Restrictions.
get   This method searches for eBay items by various query parameters and retrieves summaries of the items. You can search by keyword, category, eBay product ID (ePID), or GTIN, charity ID, or a combination of these. Note: Only FIXED_PRICE (Buy It Now) items are returned by default. However, this method does return items where both FIXED_PRICE and AUCTION are available as a buying option. After a bid has been placed, items become active auction items and are no longer returned by default, but they remain accessible by filtering for the AUCTION buying option. This method also supports the following: Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the filter parameter. Retrieving the refinements (metadata) of an item , such as item aspects (color, brand), condition, category, etc. using the fieldgroups parameter. Filtering by item aspects and other refinements using the aspect_filter parameter. Filtering for items that are compatible with a specific product, using the compatibility_filter parameter. Creating aspects histograms, which enables shoppers to drill down in each refinement narrowing the search results. For details and examples of these capabilities, see Browse API in the Buying Integration Guide. Pagination and sort controls There are pagination controls (limit and offset fields) and sort query parameters that control/sort the data that is returned. By default, the results are sorted by &quot;Best Match&quot;. For more information about Best Match, see the eBay help page Best Match. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item_summary/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item_summary/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
invalid   This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of the items. You pass in a Base64 image in the request payload and can refine the search by category, or eBay product ID (ePID), or a combination of these using URI parameters. To get the Base64 image string, you can use sites such as https://codebeautify.org/image-to-base64-converter. This method also supports the following: Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the filter parameter. Filtering by item aspects using the aspect_filter parameter. For details and examples of these capabilities, see Browse API in the Buying Integration Guide. Pagination and sort controls There are pagination controls (limit and offset fields) and sort query parameters that control/sort the data that is returned. By default, the results are sorted by &quot;Best Match&quot;. For more information about Best Match, see the eBay help page Best Match. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item_summary/search_by_image/ Sandbox URL: Due to the data available, this method is not supported in the eBay Sandbox. To test your integration, use the Production URL. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. URL Encoding for Parameters Query parameter values need to be URL encoded. For details, see URL encoding query parameter values. For readability, code examples in this document have not been URL encoded. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
invalid   This is an experimental method. This method retrieves all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. There are no URI parameters or request payload. The response returns the summary details of all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. If the cart is empty, the response is HTTP 204. The quantity and state of an item changes often. If the item becomes &quot;unavailable&quot; such as, when the listing has ended or the item is out of stock, the item will be returned in the unavailableCartItems container. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/shopping_cart/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/ Note: This method is not available in the eBay API Explorer. Restrictions This method can be used only for eBay members. For a list of supported sites and other restrictions, see API Restrictions.
invalid   This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and adds items to that cart. Because a cart never expires, any item added to the cart will remain in the cart until it is removed. To use this method, you must submit a RESTful item ID and the quantity of the item. If the quantity value is greater than the number of available, the quantity value is changed to the number available and a warning is returned. For example, if there are 15 baseballs available and you set the quantity value to 50, the service automatically changes the value of quantity to 15. The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. The quantity and state of an item changes often. If the item becomes &quot;unavailable&quot; such as, when the listing has ended or the item is out of stock, whether it has just been added to the cart or has been in the cart for some time, the item will be returned in the unavailableCartItems container. Note: There are differences between how legacy APIs, such as Finding, and RESTful APIs, such as Browse, return the identifier of an &quot;item&quot; and what the item ID represents. If you have an item ID from one of the legacy APIs, you can use the legacy item ID with the getItemByLegacyId method to retrieve the RESTful ID for that item. For more information about how to use legacy IDs with the Buy APIs, see Legacy API compatibility in the Buying Integration guide. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/shopping_cart/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/ Note: This method is not available in the eBay API Explorer. Restrictions This method can be used only for eBay members. You can add only items with a FIXED_PRICE that accept PayPal as a payment. For a list of supported sites and other restrictions, see API Restrictions.
delete   This is an experimental method. This method removes a specific item from the eBay member's cart. You specify the ID of the item in the cart (cartItemId) that you want to remove. The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. If you remove the last item in the cart, the response is HTTP 204. The quantity and state of an item changes often. If the item becomes &quot;unavailable&quot; such as, when the listing has ended or the item is out of stock, the item will be returned in the unavailableCartItems container. Note: The cartItemId is not the same as the item ID. The cartItemId is the identifier of a specific item in the cart and is generated when the item was added to the cart. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/shopping_cart/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/ Note: This method is not available in the eBay API Explorer. Restrictions This method can be used only for eBay members. For a list of supported sites and other restrictions, see API Restrictions.
put   This is an experimental method. This method updates the quantity value of a specific item in the eBay member's cart. You specify the ID of the item in the cart (cartItemId) and the new value for the quantity. If the quantity value is greater than the number of available, the quantity value is changed to the number available and a warning is returned. For example, if there are 15 baseballs available and you set the quantity value to 50, the service automatically changes the value of quantity to 15. The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. The quantity and state of an item changes often. If the item becomes &quot;unavailable&quot; such as, the listing has ended or the item is out of stock, the item will be returned in the unavailableCartItems container. Note: The cartItemId is not the same as the item ID. The cartItemId is the identifier of a specific item in the cart and is generated when the item was added to the cart. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/shopping_cart/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/ Note: This method is not available in the eBay API Explorer. Restrictions This method can be used only for eBay members. For a list of supported sites and other restrictions, see API Restrictions.
get   This method retrieves all the fulfillment policies configured for the marketplace you specify using the marketplace_id query parameter. Marketplaces and locales Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.
post   This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the shipment options that the seller offers to buyers. Each policy targets a marketplaceId and categoryTypes.name combination and you can create multiple policies for each combination. Be aware that some marketplaces require a specific fulfillment policy for vehicle listings. A successful request returns the URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload. Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies. Marketplaces and locales Policy instructions can be localized by providing a locale in the Accept-Language HTTP request header. For example, the following setting displays field values from the request body in German: Accept-Language: de-DE. Target the specific locale of a marketplace that supports multiple locales using the Content-Language request header. For example, target the French locale of the Canadian marketplace by specifying the fr-CA locale for Content-Language. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. Tip: For details on headers, see HTTP request headers.
get   This method retrieves the complete details for a single fulfillment policy. In the request, supply both the policy name and its associated marketplace_id as query parameters. Marketplaces and locales Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.
delete   This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the fulfillmentPolicyId path parameter. Note that you cannot delete the default fulfillment policy.
get   This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.
put   This method updates an existing fulfillment policy. Specify the policy you want to update using the fulfillment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.
get   This method is used by sellers onboarded for eBay managed payments, or sellers who are currently going through, or who are eligible for onboarding for eBay managed payments. With this method, a seller can discover if there are any action items in regards to providing more documentation and/or information about themselves, their company, or the bank account they are or will be using for seller payouts. These 'action items' are also know as 'Know Your Customer' (or KYC) checks. This method does not require any parameters other than the OAuth user token associated with the seller's account. If the managed payments seller does not currently have any pending 'KYC' action items, only a 204 No Content HTTP status code is returned, and no response payload. Note: This method is not applicable for sellers who are not eligible for eBay managed payments. For sellers who sell on one or more eBay marketplaces that currently support managed payments, they can check on their managed payments onboarding status by using the getPaymentsProgramOnboarding method.
get   This method retrieves all the payment policies configured for the marketplace you specify using the marketplace_id query parameter. Marketplaces and locales Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.
post   This method creates a new payment policy where the policy encapsulates seller's terms for purchase payments. Each policy targets a marketplaceId and categoryTypes.name combination and you can create multiple policies for each combination. Be aware that some marketplaces require a specific payment policy for vehicle listings. A successful request returns the URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload. Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies. Marketplaces and locales Policy instructions can be localized by providing a locale in the Accept-Language HTTP request header. For example, the following setting displays field values from the request body in German: Accept-Language: de-DE. Target the specific locale of a marketplace that supports multiple locales using the Content-Language request header. For example, target the French locale of the Canadian marketplace by specifying the fr-CA locale for Content-Language. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. Tip: For details on headers, see HTTP request headers.
get   This method retrieves the complete details of a single payment policy. Supply both the policy name and its associated marketplace_id in the request query parameters. Marketplaces and locales Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.
delete   This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter. Note that you cannot delete the default payment policy.
get   This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve using the paymentPolicyId path parameter.
put   This method updates an existing payment policy. Specify the policy you want to update using the payment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.
get   This method returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the marketplace_id path parameter to specify the marketplace of the status flag you want returned. Note: Currently, the only supported payments program is eBay Payments. For details, see: Managed Payments on eBay Payments Terms of Use
get   This method retrieves a seller's onboarding status of eBay managed payments for a specified marketplace. The overall onboarding status of the seller and the status of each onboarding step is returned. Presently, the only supported payments program type is EBAY_PAYMENTS. See Managed Payments on eBay and Payments Terms of Use. Note: Managed payments availability: eBay managed payments is presently available in the US and Germany, and will roll out to Canada, UK, and Australia in July 2020.
get   This method retrieves the seller's current set of privileges. The call returns whether or not the seller's eBay registration has been completed, as well as the details of their site-wide sellingLimt (the amount and quantity they can sell on a given day).
get   This method gets a list of the seller programs that the seller has opted-in to.
post   This method opts the seller in to an eBay seller program. Refer to the Account API overview for information about available eBay seller programs. Note: It can take up to 24-hours for eBay to process your request to opt-in to a Seller Program. Use the getOptedInPrograms call to check the status of your request after the processing period has passed.
post   This method opts the seller out of a seller program to which you have previously opted-in to. Get a list of the seller programs you have opted-in to using the getOptedInPrograms call.
get   This method retrieves a seller's shipping rate tables for the country specified in the country_code query parameter. If you call this method without specifying a country code, the call returns all the seller's shipping rate tables. The method's response includes a rateTableId for each table defined by the seller. Use a table's ID value in a fulfillment policy to specify the shipping rate table to use for that policy's DOMESTIC or INTERNATIONAL shipping option (make sure the locality of the rate table matches the optionType of the shipping option). This call currently supports getting rate tables related to the following marketplaces: EBAY_AU EBAY_CA EBAY_DE EBAY_ES EBAY_FR EBAY_GB EBAY_IT EBAY_US Note: Rate tables created with the Trading API might not have been assigned a rateTableId at the time of their creation. This method can assign and return rateTableId values for rate tables with missing IDs if you make a request using the country_code where the seller has defined rate tables. Sellers can define up to 40 shipping rate tables for their account, which lets them set up different rate tables for each of the marketplaces they sell into. Go to My eBay &gt; Account &gt; Site Preferences to create and maintain the rate tables. For more, see Using shipping rate tables. If you're using the Trading API, use the rate table ID values in the RateTableDetails container of the Add/Revise/Relist calls. If the locality for a rate table is set to DOMESTIC, pass the ID value in the RateTableDetails.DomesticRateTableId field. Otherwise, if locality is INTERNATIONAL, pass the ID value in RateTableDetails.InternationalRateTableId.
get   This method retrieves all the return policies configured for the marketplace you specify using the marketplace_id query parameter. Marketplaces and locales Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.
post   This method creates a new return policy where the policy encapsulates seller's terms for returning items. Use the Metadata API method getReturnPolicies to determine which categories require you to supply a return policy for the marketplace(s) into which you list. Each policy targets a marketplaceId and categoryTypes.name combination and you can create multiple policies for each combination. A successful request returns the URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload. Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies. Marketplaces and locales Policy instructions can be localized by providing a locale in the Accept-Language HTTP request header. For example, the following setting displays field values from the request body in German: Accept-Language: de-DE. Target the specific locale of a marketplace that supports multiple locales using the Content-Language request header. For example, target the French locale of the Canadian marketplace by specifying the fr-CA locale for Content-Language. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. Tip: For details on headers, see HTTP request headers.
get   This method retrieves the complete details of a single return policy. Supply both the policy name and its associated marketplace_id in the request query parameters. Marketplaces and locales Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.
delete   This method deletes a return policy. Supply the ID of the policy you want to delete in the returnPolicyId path parameter. Note that you cannot delete the default return policy.
get   This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.
put   This method updates an existing return policy. Specify the policy you want to update using the return_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.
get   Use this call to retrieve a sales tax table that the seller established for a specific country. Specify the tax table to retrieve using the country_code query parameter.
delete   This call deletes a tax table entry for a jurisdiction. Specify the jurisdiction to delete using the countryCode and jurisdictionId path parameters.
get   This call gets the current tax table entry for a specific tax jurisdiction. Specify the jurisdiction to retrieve using the countryCode and jurisdictionId path parameters.
invalid   This method creates or updates a sales tax table entry for a jurisdiction. Specify the tax table entry you want to configure using the two path parameters: countryCode and jurisdictionId. A tax table entry for a jurisdiction is comprised of two fields: one for the jurisdiction's sales-tax rate and another that's a boolean value indicating whether or not shipping and handling are taxed in the jurisdiction. You can set up tax tables for countries that support different tax jurisdictions. Currently, only Canada, India, and the US support separate tax jurisdictions. If you sell into any of these countries, you can set up tax tables for any of the country's jurisdictions. Retrieve valid jurisdiction IDs using getSalesTaxJurisdictions in the Metadata API. For details on using this call, see Establishing sales-tax tables. Important! Starting in January 2019, eBay will begin to calculate, collect, and remit sales tax on behalf of sellers for items shipped to customers. This feature is rolling out on specific dates to specific US states as defined on the following page: eBay sales tax collection. Once eBay starts to collect sales tax for a state, no action is required on the seller's part and there will be no charges or fees for eBay automatically calculating, collecting and remitting sales tax. The sales-tax collection process will apply to all the sales in the states that support this feature, whether the seller is located in or outside of the United States. When a buyer purchases an item on eBay, and the ship-to address is one of the states where eBay collects the sales tax, eBay will calculate and add the applicable sales tax at checkout. The buyer will pay both the cost of the item along with the sales tax. eBay will collect and remit the tax.
get   List all active player alliances---Alternate route: `/dev/alliances/`Alternate route: `/legacy/alliances/`Alternate route: `/v1/alliances/`---This route is cached for up to 3600 seconds
get   Public information about an alliance---Alternate route: `/dev/alliances/{alliance_id}/`Alternate route: `/v3/alliances/{alliance_id}/`---This route is cached for up to 3600 seconds
get   Return contacts of an alliance---Alternate route: `/dev/alliances/{alliance_id}/contacts/`Alternate route: `/v2/alliances/{alliance_id}/contacts/`---This route is cached for up to 300 seconds
get   Return custom labels for an alliance's contacts---Alternate route: `/dev/alliances/{alliance_id}/contacts/labels/`Alternate route: `/legacy/alliances/{alliance_id}/contacts/labels/`Alternate route: `/v1/alliances/{alliance_id}/contacts/labels/`---This route is cached for up to 300 seconds
get   List all current member corporations of an alliance---Alternate route: `/dev/alliances/{alliance_id}/corporations/`Alternate route: `/legacy/alliances/{alliance_id}/corporations/`Alternate route: `/v1/alliances/{alliance_id}/corporations/`---This route is cached for up to 3600 seconds
get   Get the icon urls for a alliance---Alternate route: `/dev/alliances/{alliance_id}/icons/`Alternate route: `/legacy/alliances/{alliance_id}/icons/`Alternate route: `/v1/alliances/{alliance_id}/icons/`---This route expires daily at 11:05
post   Bulk lookup of character IDs to corporation, alliance and faction---Alternate route: `/dev/characters/affiliation/`Alternate route: `/legacy/characters/affiliation/`Alternate route: `/v1/characters/affiliation/`---This route is cached for up to 3600 seconds
get   Public information about a character---Alternate route: `/dev/characters/{character_id}/`Alternate route: `/v4/characters/{character_id}/`---This route is cached for up to 3600 seconds
get   Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay * days(currentTime - researchStartDate)---Alternate route: `/dev/characters/{character_id}/agents_research/`Alternate route: `/legacy/characters/{character_id}/agents_research/`Alternate route: `/v1/characters/{character_id}/agents_research/`---This route is cached for up to 3600 seconds
get   Return a list of the characters assets---Alternate route: `/dev/characters/{character_id}/assets/`Alternate route: `/v3/characters/{character_id}/assets/`---This route is cached for up to 3600 seconds
get   Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0)---Alternate route: `/dev/characters/{character_id}/assets/locations/`Alternate route: `/v2/characters/{character_id}/assets/locations/`
get   Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships.---Alternate route: `/dev/characters/{character_id}/assets/names/`Alternate route: `/legacy/characters/{character_id}/assets/names/`Alternate route: `/v1/characters/{character_id}/assets/names/`
get   Return attributes of a character---Alternate route: `/dev/characters/{character_id}/attributes/`Alternate route: `/legacy/characters/{character_id}/attributes/`Alternate route: `/v1/characters/{character_id}/attributes/`---This route is cached for up to 3600 seconds
get   Return a list of blueprints the character owns---Alternate route: `/dev/characters/{character_id}/blueprints/`Alternate route: `/v2/characters/{character_id}/blueprints/`---This route is cached for up to 3600 seconds
get   A list of your character's personal bookmarks---Alternate route: `/dev/characters/{character_id}/bookmarks/`Alternate route: `/v2/characters/{character_id}/bookmarks/`---This route is cached for up to 3600 seconds
get   A list of your character's personal bookmark folders---Alternate route: `/dev/characters/{character_id}/bookmarks/folders/`Alternate route: `/v2/characters/{character_id}/bookmarks/folders/`---This route is cached for up to 3600 seconds
get   Get 50 event summaries from the calendar. If no from_event ID is given, the resource will return the next 50 chronological event summaries from now. If a from_event ID is specified, it will return the next 50 chronological event summaries from after that event---Alternate route: `/dev/characters/{character_id}/calendar/`Alternate route: `/legacy/characters/{character_id}/calendar/`Alternate route: `/v1/characters/{character_id}/calendar/`---This route is cached for up to 5 seconds
get   Get all the information for a specific event---Alternate route: `/dev/characters/{character_id}/calendar/{event_id}/`Alternate route: `/v3/characters/{character_id}/calendar/{event_id}/`---This route is cached for up to 5 seconds
post   Set your response status to an event---Alternate route: `/dev/characters/{character_id}/calendar/{event_id}/`Alternate route: `/v3/characters/{character_id}/calendar/{event_id}/`
get   Get all invited attendees for a given event---Alternate route: `/dev/characters/{character_id}/calendar/{event_id}/attendees/`Alternate route: `/legacy/characters/{character_id}/calendar/{event_id}/attendees/`Alternate route: `/v1/characters/{character_id}/calendar/{event_id}/attendees/`---This route is cached for up to 600 seconds
get   A list of the character's clones---Alternate route: `/dev/characters/{character_id}/clones/`Alternate route: `/v3/characters/{character_id}/clones/`---This route is cached for up to 120 seconds
delete   Bulk delete contacts---Alternate route: `/dev/characters/{character_id}/contacts/`Alternate route: `/v2/characters/{character_id}/contacts/`
get   Return contacts of a character---Alternate route: `/dev/characters/{character_id}/contacts/`Alternate route: `/v2/characters/{character_id}/contacts/`---This route is cached for up to 300 seconds
post   Bulk add contacts with same settings---Alternate route: `/dev/characters/{character_id}/contacts/`Alternate route: `/v2/characters/{character_id}/contacts/`
post   Bulk edit contacts with same settings---Alternate route: `/dev/characters/{character_id}/contacts/`Alternate route: `/v2/characters/{character_id}/contacts/`
get   Return custom labels for a character's contacts---Alternate route: `/dev/characters/{character_id}/contacts/labels/`Alternate route: `/legacy/characters/{character_id}/contacts/labels/`Alternate route: `/v1/characters/{character_id}/contacts/labels/`---This route is cached for up to 300 seconds
get   Returns contracts available to a character, only if the character is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress".---Alternate route: `/dev/characters/{character_id}/contracts/`Alternate route: `/legacy/characters/{character_id}/contracts/`Alternate route: `/v1/characters/{character_id}/contracts/`---This route is cached for up to 300 seconds
get   Lists bids on a particular auction contract---Alternate route: `/dev/characters/{character_id}/contracts/{contract_id}/bids/`Alternate route: `/legacy/characters/{character_id}/contracts/{contract_id}/bids/`Alternate route: `/v1/characters/{character_id}/contracts/{contract_id}/bids/`---This route is cached for up to 300 seconds
get   Lists items of a particular contract---Alternate route: `/dev/characters/{character_id}/contracts/{contract_id}/items/`Alternate route: `/legacy/characters/{character_id}/contracts/{contract_id}/items/`Alternate route: `/v1/characters/{character_id}/contracts/{contract_id}/items/`---This route is cached for up to 3600 seconds
get   Get a list of all the corporations a character has been a member of---Alternate route: `/dev/characters/{character_id}/corporationhistory/`Alternate route: `/legacy/characters/{character_id}/corporationhistory/`Alternate route: `/v1/characters/{character_id}/corporationhistory/`---This route is cached for up to 3600 seconds
get   Takes a source character ID in the url and a set of target character ID's in the body, returns a CSPA charge cost---Alternate route: `/dev/characters/{character_id}/cspa/`Alternate route: `/v4/characters/{character_id}/cspa/`
get   Return a character's jump activation and fatigue information---Alternate route: `/dev/characters/{character_id}/fatigue/`Alternate route: `/legacy/characters/{character_id}/fatigue/`Alternate route: `/v1/characters/{character_id}/fatigue/`---This route is cached for up to 300 seconds
get   Return fittings of a character---Alternate route: `/dev/characters/{character_id}/fittings/`Alternate route: `/legacy/characters/{character_id}/fittings/`Alternate route: `/v1/characters/{character_id}/fittings/`---This route is cached for up to 300 seconds
post   Save a new fitting for a character---Alternate route: `/dev/characters/{character_id}/fittings/`Alternate route: `/legacy/characters/{character_id}/fittings/`Alternate route: `/v1/characters/{character_id}/fittings/`
delete   Delete a fitting from a character---Alternate route: `/dev/characters/{character_id}/fittings/{fitting_id}/`Alternate route: `/legacy/characters/{character_id}/fittings/{fitting_id}/`Alternate route: `/v1/characters/{character_id}/fittings/{fitting_id}/`
get   Return the fleet ID the character is in, if any.---Alternate route: `/dev/characters/{character_id}/fleet/`Alternate route: `/legacy/characters/{character_id}/fleet/`Alternate route: `/v1/characters/{character_id}/fleet/`---This route is cached for up to 60 seconds
get   Statistical overview of a character involved in faction warfare---Alternate route: `/dev/characters/{character_id}/fw/stats/`Alternate route: `/legacy/characters/{character_id}/fw/stats/`Alternate route: `/v1/characters/{character_id}/fw/stats/`---This route expires daily at 11:05
get   Return implants on the active clone of a character---Alternate route: `/dev/characters/{character_id}/implants/`Alternate route: `/legacy/characters/{character_id}/implants/`Alternate route: `/v1/characters/{character_id}/implants/`---This route is cached for up to 300 seconds
get   List industry jobs placed by a character---Alternate route: `/dev/characters/{character_id}/industry/jobs/`Alternate route: `/legacy/characters/{character_id}/industry/jobs/`Alternate route: `/v1/characters/{character_id}/industry/jobs/`---This route is cached for up to 300 seconds
get   Return a list of a character's kills and losses going back 90 days---Alternate route: `/dev/characters/{character_id}/killmails/recent/`Alternate route: `/legacy/characters/{character_id}/killmails/recent/`Alternate route: `/v1/characters/{character_id}/killmails/recent/`---This route is cached for up to 300 seconds
get   Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable---Alternate route: `/dev/characters/{character_id}/location/`Alternate route: `/legacy/characters/{character_id}/location/`Alternate route: `/v1/characters/{character_id}/location/`---This route is cached for up to 5 seconds
get   Return a list of loyalty points for all corporations the character has worked for---Alternate route: `/dev/characters/{character_id}/loyalty/points/`Alternate route: `/legacy/characters/{character_id}/loyalty/points/`Alternate route: `/v1/characters/{character_id}/loyalty/points/`---This route is cached for up to 3600 seconds
get   Return the 50 most recent mail headers belonging to the character that match the query criteria. Queries can be filtered by label, and last_mail_id can be used to paginate backwards---Alternate route: `/dev/characters/{character_id}/mail/`Alternate route: `/legacy/characters/{character_id}/mail/`Alternate route: `/v1/characters/{character_id}/mail/`---This route is cached for up to 30 seconds
post   Create and send a new mail---Alternate route: `/dev/characters/{character_id}/mail/`Alternate route: `/legacy/characters/{character_id}/mail/`Alternate route: `/v1/characters/{character_id}/mail/`
get   Return a list of the users mail labels, unread counts for each label and a total unread count.---Alternate route: `/dev/characters/{character_id}/mail/labels/`Alternate route: `/v3/characters/{character_id}/mail/labels/`---This route is cached for up to 30 seconds
post   Create a mail label---Alternate route: `/dev/characters/{character_id}/mail/labels/`Alternate route: `/legacy/characters/{character_id}/mail/labels/`Alternate route: `/v2/characters/{character_id}/mail/labels/`
delete   Delete a mail label---Alternate route: `/dev/characters/{character_id}/mail/labels/{label_id}/`Alternate route: `/legacy/characters/{character_id}/mail/labels/{label_id}/`Alternate route: `/v1/characters/{character_id}/mail/labels/{label_id}/`
get   Return all mailing lists that the character is subscribed to---Alternate route: `/dev/characters/{character_id}/mail/lists/`Alternate route: `/legacy/characters/{character_id}/mail/lists/`Alternate route: `/v1/characters/{character_id}/mail/lists/`---This route is cached for up to 120 seconds
delete   Delete a mail---Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/`Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/`Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/`
get   Return the contents of an EVE mail---Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/`Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/`Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/`---This route is cached for up to 30 seconds
put   Update metadata about a mail---Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/`Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/`Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/`
get   Return a list of medals the character has---Alternate route: `/dev/characters/{character_id}/medals/`Alternate route: `/legacy/characters/{character_id}/medals/`Alternate route: `/v1/characters/{character_id}/medals/`---This route is cached for up to 3600 seconds
get   Paginated record of all mining done by a character for the past 30 days---Alternate route: `/dev/characters/{character_id}/mining/`Alternate route: `/legacy/characters/{character_id}/mining/`Alternate route: `/v1/characters/{character_id}/mining/`---This route is cached for up to 600 seconds
get   Return character notifications---Alternate route: `/dev/characters/{character_id}/notifications/`Alternate route: `/v4/characters/{character_id}/notifications/`---This route is cached for up to 600 seconds
get   Return notifications about having been added to someone's contact list---Alternate route: `/dev/characters/{character_id}/notifications/contacts/`Alternate route: `/legacy/characters/{character_id}/notifications/contacts/`Alternate route: `/v1/characters/{character_id}/notifications/contacts/`---This route is cached for up to 600 seconds
post   Checks if the character is currently online---Alternate route: `/dev/characters/{character_id}/online/`Alternate route: `/v2/characters/{character_id}/online/`---This route is cached for up to 60 seconds
get   Return a list of tasks finished by a character---Alternate route: `/dev/characters/{character_id}/opportunities/`Alternate route: `/legacy/characters/{character_id}/opportunities/`Alternate route: `/v1/characters/{character_id}/opportunities/`---This route is cached for up to 3600 seconds
get   List open market orders placed by a character---Alternate route: `/dev/characters/{character_id}/orders/`Alternate route: `/v2/characters/{character_id}/orders/`---This route is cached for up to 1200 seconds
get   List cancelled and expired market orders placed by a character up to 90 days in the past.---Alternate route: `/dev/characters/{character_id}/orders/history/`Alternate route: `/legacy/characters/{character_id}/orders/history/`Alternate route: `/v1/characters/{character_id}/orders/history/`---This route is cached for up to 3600 seconds
get   Returns a list of all planetary colonies owned by a character.---Alternate route: `/dev/characters/{character_id}/planets/`Alternate route: `/legacy/characters/{character_id}/planets/`Alternate route: `/v1/characters/{character_id}/planets/`---This route is cached for up to 600 seconds
get   Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met.---Alternate route: `/dev/characters/{character_id}/planets/{planet_id}/`Alternate route: `/v3/characters/{character_id}/planets/{planet_id}/`---This route is cached for up to 600 seconds
get   Get portrait urls for a character---Alternate route: `/dev/characters/{character_id}/portrait/`Alternate route: `/v2/characters/{character_id}/portrait/`---This route expires daily at 11:05
get   Returns a character's corporation roles---Alternate route: `/dev/characters/{character_id}/roles/`Alternate route: `/v2/characters/{character_id}/roles/`---This route is cached for up to 3600 seconds
get   Search for entities that match a given sub-string.---Alternate route: `/dev/characters/{character_id}/search/`Alternate route: `/v3/characters/{character_id}/search/`---This route is cached for up to 3600 seconds
get   Get the current ship type, name and id---Alternate route: `/dev/characters/{character_id}/ship/`Alternate route: `/legacy/characters/{character_id}/ship/`Alternate route: `/v1/characters/{character_id}/ship/`---This route is cached for up to 5 seconds
get   List the configured skill queue for the given character---Alternate route: `/dev/characters/{character_id}/skillqueue/`Alternate route: `/legacy/characters/{character_id}/skillqueue/`Alternate route: `/v2/characters/{character_id}/skillqueue/`---This route is cached for up to 120 seconds
get   List all trained skills for the given character---Alternate route: `/dev/characters/{character_id}/skills/`Alternate route: `/v4/characters/{character_id}/skills/`---This route is cached for up to 120 seconds
get   Return character standings from agents, NPC corporations, and factions---Alternate route: `/dev/characters/{character_id}/standings/`Alternate route: `/legacy/characters/{character_id}/standings/`Alternate route: `/v1/characters/{character_id}/standings/`---This route is cached for up to 3600 seconds
get   Returns aggregate yearly stats for a character---Alternate route: `/dev/characters/{character_id}/stats/`Alternate route: `/v2/characters/{character_id}/stats/`---This route is cached for up to 86400 seconds
get   Returns a character's titles---Alternate route: `/dev/characters/{character_id}/titles/`Alternate route: `/legacy/characters/{character_id}/titles/`Alternate route: `/v1/characters/{character_id}/titles/`---This route is cached for up to 3600 seconds
get   Returns a character's wallet balance---Alternate route: `/dev/characters/{character_id}/wallet/`Alternate route: `/legacy/characters/{character_id}/wallet/`Alternate route: `/v1/characters/{character_id}/wallet/`---This route is cached for up to 120 seconds
get   Retrieve the given character's wallet journal going 30 days back---Alternate route: `/legacy/characters/{character_id}/wallet/journal/`Alternate route: `/v4/characters/{character_id}/wallet/journal/`---This route is cached for up to 3600 seconds---Warning: This route has an upgrade available---[Diff of the upcoming changes](https://esi.evetech.net/diff/latest/dev/#GET-/characters/{character_id}/wallet/journal/)
get   Get wallet transactions of a character---Alternate route: `/dev/characters/{character_id}/wallet/transactions/`Alternate route: `/legacy/characters/{character_id}/wallet/transactions/`Alternate route: `/v1/characters/{character_id}/wallet/transactions/`---This route is cached for up to 3600 seconds
get   Lists bids on a public auction contract---Alternate route: `/dev/contracts/public/bids/{contract_id}/`Alternate route: `/legacy/contracts/public/bids/{contract_id}/`Alternate route: `/v1/contracts/public/bids/{contract_id}/`---This route is cached for up to 300 seconds
get   Lists items of a public contract---Alternate route: `/dev/contracts/public/items/{contract_id}/`Alternate route: `/legacy/contracts/public/items/{contract_id}/`Alternate route: `/v1/contracts/public/items/{contract_id}/`---This route is cached for up to 3600 seconds
get   Returns a paginated list of all public contracts in the given region---Alternate route: `/dev/contracts/public/{region_id}/`Alternate route: `/legacy/contracts/public/{region_id}/`Alternate route: `/v1/contracts/public/{region_id}/`---This route is cached for up to 1800 seconds
post   Extraction timers for all moon chunks being extracted by refineries belonging to a corporation.---Alternate route: `/dev/corporation/{corporation_id}/mining/extractions/`Alternate route: `/legacy/corporation/{corporation_id}/mining/extractions/`Alternate route: `/v1/corporation/{corporation_id}/mining/extractions/`---This route is cached for up to 1800 seconds---Requires one of the following EVE corporation role(s): Station_Manager
get   Paginated list of all entities capable of observing and recording mining for a corporation---Alternate route: `/dev/corporation/{corporation_id}/mining/observers/`Alternate route: `/legacy/corporation/{corporation_id}/mining/observers/`Alternate route: `/v1/corporation/{corporation_id}/mining/observers/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Accountant
get   Paginated record of all mining seen by an observer---Alternate route: `/dev/corporation/{corporation_id}/mining/observers/{observer_id}/`Alternate route: `/legacy/corporation/{corporation_id}/mining/observers/{observer_id}/`Alternate route: `/v1/corporation/{corporation_id}/mining/observers/{observer_id}/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Accountant
get   Get a list of npc corporations---Alternate route: `/dev/corporations/npccorps/`Alternate route: `/legacy/corporations/npccorps/`Alternate route: `/v1/corporations/npccorps/`---This route expires daily at 11:05
post   Public information about a corporation---Alternate route: `/dev/corporations/{corporation_id}/`Alternate route: `/v4/corporations/{corporation_id}/`---This route is cached for up to 3600 seconds
get   Get a list of all the alliances a corporation has been a member of---Alternate route: `/dev/corporations/{corporation_id}/alliancehistory/`Alternate route: `/v2/corporations/{corporation_id}/alliancehistory/`---This route is cached for up to 3600 seconds
get   Return a list of the corporation assets---Alternate route: `/dev/corporations/{corporation_id}/assets/`Alternate route: `/v3/corporations/{corporation_id}/assets/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
post   Return locations for a set of item ids, which you can get from corporation assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0)---Alternate route: `/dev/corporations/{corporation_id}/assets/locations/`Alternate route: `/v2/corporations/{corporation_id}/assets/locations/`---Requires one of the following EVE corporation role(s): Director
post   Return names for a set of item ids, which you can get from corporation assets endpoint. Only valid for items that can customize names, like containers or ships---Alternate route: `/dev/corporations/{corporation_id}/assets/names/`Alternate route: `/legacy/corporations/{corporation_id}/assets/names/`Alternate route: `/v1/corporations/{corporation_id}/assets/names/`---Requires one of the following EVE corporation role(s): Director
get   Returns a list of blueprints the corporation owns---Alternate route: `/dev/corporations/{corporation_id}/blueprints/`Alternate route: `/v2/corporations/{corporation_id}/blueprints/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   A list of your corporation's bookmarks---Alternate route: `/dev/corporations/{corporation_id}/bookmarks/`Alternate route: `/legacy/corporations/{corporation_id}/bookmarks/`Alternate route: `/v1/corporations/{corporation_id}/bookmarks/`---This route is cached for up to 3600 seconds
get   A list of your corporation's bookmark folders---Alternate route: `/dev/corporations/{corporation_id}/bookmarks/folders/`Alternate route: `/legacy/corporations/{corporation_id}/bookmarks/folders/`Alternate route: `/v1/corporations/{corporation_id}/bookmarks/folders/`---This route is cached for up to 3600 seconds
get   Return contacts of a corporation---Alternate route: `/dev/corporations/{corporation_id}/contacts/`Alternate route: `/v2/corporations/{corporation_id}/contacts/`---This route is cached for up to 300 seconds
get   Return custom labels for a corporation's contacts---Alternate route: `/dev/corporations/{corporation_id}/contacts/labels/`Alternate route: `/legacy/corporations/{corporation_id}/contacts/labels/`Alternate route: `/v1/corporations/{corporation_id}/contacts/labels/`---This route is cached for up to 300 seconds
get   Returns logs recorded in the past seven days from all audit log secure containers (ALSC) owned by a given corporation---Alternate route: `/dev/corporations/{corporation_id}/containers/logs/`Alternate route: `/v2/corporations/{corporation_id}/containers/logs/`---This route is cached for up to 600 seconds---Requires one of the following EVE corporation role(s): Director
get   Returns contracts available to a corporation, only if the corporation is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress".---Alternate route: `/dev/corporations/{corporation_id}/contracts/`Alternate route: `/legacy/corporations/{corporation_id}/contracts/`Alternate route: `/v1/corporations/{corporation_id}/contracts/`---This route is cached for up to 300 seconds
get   Lists bids on a particular auction contract---Alternate route: `/dev/corporations/{corporation_id}/contracts/{contract_id}/bids/`Alternate route: `/legacy/corporations/{corporation_id}/contracts/{contract_id}/bids/`Alternate route: `/v1/corporations/{corporation_id}/contracts/{contract_id}/bids/`---This route is cached for up to 3600 seconds
get   Lists items of a particular contract---Alternate route: `/dev/corporations/{corporation_id}/contracts/{contract_id}/items/`Alternate route: `/legacy/corporations/{corporation_id}/contracts/{contract_id}/items/`Alternate route: `/v1/corporations/{corporation_id}/contracts/{contract_id}/items/`---This route is cached for up to 3600 seconds
get   List customs offices owned by a corporation---Alternate route: `/dev/corporations/{corporation_id}/customs_offices/`Alternate route: `/legacy/corporations/{corporation_id}/customs_offices/`Alternate route: `/v1/corporations/{corporation_id}/customs_offices/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Return corporation hangar and wallet division names, only show if a division is not using the default name---Alternate route: `/dev/corporations/{corporation_id}/divisions/`Alternate route: `/legacy/corporations/{corporation_id}/divisions/`Alternate route: `/v1/corporations/{corporation_id}/divisions/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Return a corporation's facilities---Alternate route: `/dev/corporations/{corporation_id}/facilities/`Alternate route: `/legacy/corporations/{corporation_id}/facilities/`Alternate route: `/v1/corporations/{corporation_id}/facilities/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Factory_Manager
get   Statistics about a corporation involved in faction warfare---Alternate route: `/dev/corporations/{corporation_id}/fw/stats/`Alternate route: `/legacy/corporations/{corporation_id}/fw/stats/`Alternate route: `/v1/corporations/{corporation_id}/fw/stats/`---This route expires daily at 11:05
get   Get the icon urls for a corporation---Alternate route: `/dev/corporations/{corporation_id}/icons/`Alternate route: `/legacy/corporations/{corporation_id}/icons/`Alternate route: `/v1/corporations/{corporation_id}/icons/`---This route is cached for up to 3600 seconds
get   List industry jobs run by a corporation---Alternate route: `/dev/corporations/{corporation_id}/industry/jobs/`Alternate route: `/legacy/corporations/{corporation_id}/industry/jobs/`Alternate route: `/v1/corporations/{corporation_id}/industry/jobs/`---This route is cached for up to 300 seconds---Requires one of the following EVE corporation role(s): Factory_Manager
get   Get a list of a corporation's kills and losses going back 90 days---Alternate route: `/dev/corporations/{corporation_id}/killmails/recent/`Alternate route: `/legacy/corporations/{corporation_id}/killmails/recent/`Alternate route: `/v1/corporations/{corporation_id}/killmails/recent/`---This route is cached for up to 300 seconds---Requires one of the following EVE corporation role(s): Director
get   Returns a corporation's medals---Alternate route: `/dev/corporations/{corporation_id}/medals/`Alternate route: `/legacy/corporations/{corporation_id}/medals/`Alternate route: `/v1/corporations/{corporation_id}/medals/`---This route is cached for up to 3600 seconds
get   Returns medals issued by a corporation---Alternate route: `/dev/corporations/{corporation_id}/medals/issued/`Alternate route: `/legacy/corporations/{corporation_id}/medals/issued/`Alternate route: `/v1/corporations/{corporation_id}/medals/issued/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Return the current member list of a corporation, the token's character need to be a member of the corporation.---Alternate route: `/dev/corporations/{corporation_id}/members/`Alternate route: `/v3/corporations/{corporation_id}/members/`---This route is cached for up to 3600 seconds
get   Return a corporation's member limit, not including CEO himself---Alternate route: `/dev/corporations/{corporation_id}/members/limit/`Alternate route: `/legacy/corporations/{corporation_id}/members/limit/`Alternate route: `/v1/corporations/{corporation_id}/members/limit/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Returns a corporation's members' titles---Alternate route: `/dev/corporations/{corporation_id}/members/titles/`Alternate route: `/legacy/corporations/{corporation_id}/members/titles/`Alternate route: `/v1/corporations/{corporation_id}/members/titles/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Returns additional information about a corporation's members which helps tracking their activities---Alternate route: `/dev/corporations/{corporation_id}/membertracking/`Alternate route: `/legacy/corporations/{corporation_id}/membertracking/`Alternate route: `/v1/corporations/{corporation_id}/membertracking/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   List open market orders placed on behalf of a corporation---Alternate route: `/dev/corporations/{corporation_id}/orders/`Alternate route: `/v3/corporations/{corporation_id}/orders/`---This route is cached for up to 1200 seconds---Requires one of the following EVE corporation role(s): Accountant, Trader
get   List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past.---Alternate route: `/dev/corporations/{corporation_id}/orders/history/`Alternate route: `/v2/corporations/{corporation_id}/orders/history/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Accountant, Trader
get   Return the roles of all members if the character has the personnel manager role or any grantable role.---Alternate route: `/dev/corporations/{corporation_id}/roles/`Alternate route: `/legacy/corporations/{corporation_id}/roles/`Alternate route: `/v1/corporations/{corporation_id}/roles/`---This route is cached for up to 3600 seconds
get   Return how roles have changed for a coporation's members, up to a month---Alternate route: `/dev/corporations/{corporation_id}/roles/history/`Alternate route: `/legacy/corporations/{corporation_id}/roles/history/`Alternate route: `/v1/corporations/{corporation_id}/roles/history/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Return the current shareholders of a corporation.---Alternate route: `/dev/corporations/{corporation_id}/shareholders/`Alternate route: `/legacy/corporations/{corporation_id}/shareholders/`Alternate route: `/v1/corporations/{corporation_id}/shareholders/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Return corporation standings from agents, NPC corporations, and factions---Alternate route: `/dev/corporations/{corporation_id}/standings/`Alternate route: `/legacy/corporations/{corporation_id}/standings/`Alternate route: `/v1/corporations/{corporation_id}/standings/`---This route is cached for up to 3600 seconds
get   Returns list of corporation starbases (POSes)---Alternate route: `/dev/corporations/{corporation_id}/starbases/`Alternate route: `/legacy/corporations/{corporation_id}/starbases/`Alternate route: `/v1/corporations/{corporation_id}/starbases/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Returns various settings and fuels of a starbase (POS)---Alternate route: `/dev/corporations/{corporation_id}/starbases/{starbase_id}/`Alternate route: `/legacy/corporations/{corporation_id}/starbases/{starbase_id}/`Alternate route: `/v1/corporations/{corporation_id}/starbases/{starbase_id}/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Get a list of corporation structures. This route's version includes the changes to structures detailed in this blog: https://www.eveonline.com/article/upwell-2.0-structures-changes-coming-on-february-13th Note: this route will not return any flex structures owned by a corporation, use the v3 route to have those included in the response. A list of FLEX structures can be found here: https://support.eveonline.com/hc/en-us/articles/213021829-Upwell-Structures---Alternate route: `/v2/corporations/{corporation_id}/structures/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Station_Manager---Warning: This route has an upgrade available---[Diff of the upcoming changes](https://esi.evetech.net/diff/latest/dev/#GET-/corporations/{corporation_id}/structures/)
get   Returns a corporation's titles---Alternate route: `/dev/corporations/{corporation_id}/titles/`Alternate route: `/legacy/corporations/{corporation_id}/titles/`Alternate route: `/v1/corporations/{corporation_id}/titles/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Director
get   Get a corporation's wallets---Alternate route: `/dev/corporations/{corporation_id}/wallets/`Alternate route: `/legacy/corporations/{corporation_id}/wallets/`Alternate route: `/v1/corporations/{corporation_id}/wallets/`---This route is cached for up to 300 seconds---Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant
get   Retrieve the given corporation's wallet journal for the given division going 30 days back. Note: any journal records having to do with the new navigation structures from the release of Onslaught will not show up in this version. To see those, use the v4 version of this route.---Alternate route: `/legacy/corporations/{corporation_id}/wallets/{division}/journal/`Alternate route: `/v3/corporations/{corporation_id}/wallets/{division}/journal/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant---Warning: This route has an upgrade available---[Diff of the upcoming changes](https://esi.evetech.net/diff/latest/dev/#GET-/corporations/{corporation_id}/wallets/{division}/journal/)
get   Get wallet transactions of a corporation---Alternate route: `/dev/corporations/{corporation_id}/wallets/{division}/transactions/`Alternate route: `/legacy/corporations/{corporation_id}/wallets/{division}/transactions/`Alternate route: `/v1/corporations/{corporation_id}/wallets/{division}/transactions/`---This route is cached for up to 3600 seconds---Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant
get   Get a list of dogma attribute ids---Alternate route: `/dev/dogma/attributes/`Alternate route: `/legacy/dogma/attributes/`Alternate route: `/v1/dogma/attributes/`---This route expires daily at 11:05
get   Get information on a dogma attribute---Alternate route: `/dev/dogma/attributes/{attribute_id}/`Alternate route: `/legacy/dogma/attributes/{attribute_id}/`Alternate route: `/v1/dogma/attributes/{attribute_id}/`---This route expires daily at 11:05
get   Returns info about a dynamic item resulting from mutation with a mutaplasmid.---Alternate route: `/dev/dogma/dynamic/items/{type_id}/{item_id}/`Alternate route: `/legacy/dogma/dynamic/items/{type_id}/{item_id}/`Alternate route: `/v1/dogma/dynamic/items/{type_id}/{item_id}/`---This route expires daily at 11:05
get   Get a list of dogma effect ids---Alternate route: `/dev/dogma/effects/`Alternate route: `/legacy/dogma/effects/`Alternate route: `/v1/dogma/effects/`---This route expires daily at 11:05
get   Get information on a dogma effect---Alternate route: `/dev/dogma/effects/{effect_id}/`Alternate route: `/v2/dogma/effects/{effect_id}/`---This route expires daily at 11:05
get   Return details about a fleet---Alternate route: `/dev/fleets/{fleet_id}/`Alternate route: `/legacy/fleets/{fleet_id}/`Alternate route: `/v1/fleets/{fleet_id}/`---This route is cached for up to 5 seconds
put   Update settings about a fleet---Alternate route: `/dev/fleets/{fleet_id}/`Alternate route: `/legacy/fleets/{fleet_id}/`Alternate route: `/v1/fleets/{fleet_id}/`
get   Return information about fleet members---Alternate route: `/dev/fleets/{fleet_id}/members/`Alternate route: `/legacy/fleets/{fleet_id}/members/`Alternate route: `/v1/fleets/{fleet_id}/members/`---This route is cached for up to 5 seconds
post   Invite a character into the fleet. If a character has a CSPA charge set it is not possible to invite them to the fleet using ESI---Alternate route: `/dev/fleets/{fleet_id}/members/`Alternate route: `/legacy/fleets/{fleet_id}/members/`Alternate route: `/v1/fleets/{fleet_id}/members/`
delete   Kick a fleet member---Alternate route: `/dev/fleets/{fleet_id}/members/{member_id}/`Alternate route: `/legacy/fleets/{fleet_id}/members/{member_id}/`Alternate route: `/v1/fleets/{fleet_id}/members/{member_id}/`
post   Move a fleet member around---Alternate route: `/dev/fleets/{fleet_id}/members/{member_id}/`Alternate route: `/legacy/fleets/{fleet_id}/members/{member_id}/`Alternate route: `/v1/fleets/{fleet_id}/members/{member_id}/`
delete   Delete a fleet squad, only empty squads can be deleted---Alternate route: `/dev/fleets/{fleet_id}/squads/{squad_id}/`Alternate route: `/legacy/fleets/{fleet_id}/squads/{squad_id}/`Alternate route: `/v1/fleets/{fleet_id}/squads/{squad_id}/`
post   Rename a fleet squad---Alternate route: `/dev/fleets/{fleet_id}/squads/{squad_id}/`Alternate route: `/legacy/fleets/{fleet_id}/squads/{squad_id}/`Alternate route: `/v1/fleets/{fleet_id}/squads/{squad_id}/`
get   Return information about wings in a fleet---Alternate route: `/dev/fleets/{fleet_id}/wings/`Alternate route: `/legacy/fleets/{fleet_id}/wings/`Alternate route: `/v1/fleets/{fleet_id}/wings/`---This route is cached for up to 5 seconds
post   Create a new wing in a fleet---Alternate route: `/dev/fleets/{fleet_id}/wings/`Alternate route: `/legacy/fleets/{fleet_id}/wings/`Alternate route: `/v1/fleets/{fleet_id}/wings/`
delete   Delete a fleet wing, only empty wings can be deleted. The wing may contain squads, but the squads must be empty---Alternate route: `/dev/fleets/{fleet_id}/wings/{wing_id}/`Alternate route: `/legacy/fleets/{fleet_id}/wings/{wing_id}/`Alternate route: `/v1/fleets/{fleet_id}/wings/{wing_id}/`
post   Rename a fleet wing---Alternate route: `/dev/fleets/{fleet_id}/wings/{wing_id}/`Alternate route: `/legacy/fleets/{fleet_id}/wings/{wing_id}/`Alternate route: `/v1/fleets/{fleet_id}/wings/{wing_id}/`
post   Create a new squad in a fleet---Alternate route: `/dev/fleets/{fleet_id}/wings/{wing_id}/squads/`Alternate route: `/legacy/fleets/{fleet_id}/wings/{wing_id}/squads/`Alternate route: `/v1/fleets/{fleet_id}/wings/{wing_id}/squads/`
get   Top 4 leaderboard of factions for kills and victory points separated by total, last week and yesterday---Alternate route: `/dev/fw/leaderboards/`Alternate route: `/legacy/fw/leaderboards/`Alternate route: `/v1/fw/leaderboards/`---This route expires daily at 11:05
get   Top 100 leaderboard of pilots for kills and victory points separated by total, last week and yesterday---Alternate route: `/dev/fw/leaderboards/characters/`Alternate route: `/legacy/fw/leaderboards/characters/`Alternate route: `/v1/fw/leaderboards/characters/`---This route expires daily at 11:05
get   Top 10 leaderboard of corporations for kills and victory points separated by total, last week and yesterday---Alternate route: `/dev/fw/leaderboards/corporations/`Alternate route: `/legacy/fw/leaderboards/corporations/`Alternate route: `/v1/fw/leaderboards/corporations/`---This route expires daily at 11:05
get   Statistical overviews of factions involved in faction warfare---Alternate route: `/dev/fw/stats/`Alternate route: `/legacy/fw/stats/`Alternate route: `/v1/fw/stats/`---This route expires daily at 11:05
get   An overview of the current ownership of faction warfare solar systems---Alternate route: `/dev/fw/systems/`Alternate route: `/v2/fw/systems/`---This route is cached for up to 1800 seconds
get   Data about which NPC factions are at war---Alternate route: `/dev/fw/wars/`Alternate route: `/legacy/fw/wars/`Alternate route: `/v1/fw/wars/`---This route expires daily at 11:05
get   Return a list of current incursions---Alternate route: `/dev/incursions/`Alternate route: `/legacy/incursions/`Alternate route: `/v1/incursions/`---This route is cached for up to 300 seconds
get   Return a list of industry facilities---Alternate route: `/dev/industry/facilities/`Alternate route: `/legacy/industry/facilities/`Alternate route: `/v1/industry/facilities/`---This route is cached for up to 3600 seconds
get   Return cost indices for solar systems---Alternate route: `/dev/industry/systems/`Alternate route: `/legacy/industry/systems/`Alternate route: `/v1/industry/systems/`---This route is cached for up to 3600 seconds
get   Return available insurance levels for all ship types---Alternate route: `/dev/insurance/prices/`Alternate route: `/legacy/insurance/prices/`Alternate route: `/v1/insurance/prices/`---This route is cached for up to 3600 seconds
get   Return a single killmail from its ID and hash---Alternate route: `/dev/killmails/{killmail_id}/{killmail_hash}/`Alternate route: `/legacy/killmails/{killmail_id}/{killmail_hash}/`Alternate route: `/v1/killmails/{killmail_id}/{killmail_hash}/`---This route is cached for up to 1209600 seconds
get   Return a list of offers from a specific corporation's loyalty store---Alternate route: `/dev/loyalty/stores/{corporation_id}/offers/`Alternate route: `/legacy/loyalty/stores/{corporation_id}/offers/`Alternate route: `/v1/loyalty/stores/{corporation_id}/offers/`---This route expires daily at 11:05
get   Get a list of item groups---Alternate route: `/dev/markets/groups/`Alternate route: `/legacy/markets/groups/`Alternate route: `/v1/markets/groups/`---This route expires daily at 11:05
get   Get information on an item group---Alternate route: `/dev/markets/groups/{market_group_id}/`Alternate route: `/legacy/markets/groups/{market_group_id}/`Alternate route: `/v1/markets/groups/{market_group_id}/`---This route expires daily at 11:05
get   Return a list of prices---Alternate route: `/dev/markets/prices/`Alternate route: `/legacy/markets/prices/`Alternate route: `/v1/markets/prices/`---This route is cached for up to 3600 seconds
get   Return all orders in a structure---Alternate route: `/dev/markets/structures/{structure_id}/`Alternate route: `/legacy/markets/structures/{structure_id}/`Alternate route: `/v1/markets/structures/{structure_id}/`---This route is cached for up to 300 seconds
get   Return a list of historical market statistics for the specified type in a region---Alternate route: `/dev/markets/{region_id}/history/`Alternate route: `/legacy/markets/{region_id}/history/`Alternate route: `/v1/markets/{region_id}/history/`---This route expires daily at 11:05
get   Return a list of orders in a region---Alternate route: `/dev/markets/{region_id}/orders/`Alternate route: `/legacy/markets/{region_id}/orders/`Alternate route: `/v1/markets/{region_id}/orders/`---This route is cached for up to 300 seconds
get   Return a list of type IDs that have active orders in the region, for efficient market indexing.---Alternate route: `/dev/markets/{region_id}/types/`Alternate route: `/legacy/markets/{region_id}/types/`Alternate route: `/v1/markets/{region_id}/types/`---This route is cached for up to 600 seconds
get   Return a list of opportunities groups---Alternate route: `/dev/opportunities/groups/`Alternate route: `/legacy/opportunities/groups/`Alternate route: `/v1/opportunities/groups/`---This route expires daily at 11:05
get   Return information of an opportunities group---Alternate route: `/dev/opportunities/groups/{group_id}/`Alternate route: `/legacy/opportunities/groups/{group_id}/`Alternate route: `/v1/opportunities/groups/{group_id}/`---This route expires daily at 11:05
get   Return a list of opportunities tasks---Alternate route: `/dev/opportunities/tasks/`Alternate route: `/legacy/opportunities/tasks/`Alternate route: `/v1/opportunities/tasks/`---This route expires daily at 11:05
get   Return information of an opportunities task---Alternate route: `/dev/opportunities/tasks/{task_id}/`Alternate route: `/legacy/opportunities/tasks/{task_id}/`Alternate route: `/v1/opportunities/tasks/{task_id}/`---This route expires daily at 11:05
get   Get the systems between origin and destination---Alternate route: `/dev/route/{origin}/{destination}/`Alternate route: `/legacy/route/{origin}/{destination}/`Alternate route: `/v1/route/{origin}/{destination}/`---This route is cached for up to 86400 seconds
post   Search for entities that match a given sub-string.---Alternate route: `/dev/search/`Alternate route: `/v2/search/`---This route is cached for up to 3600 seconds
get   Shows sovereignty data for campaigns.---Alternate route: `/dev/sovereignty/campaigns/`Alternate route: `/legacy/sovereignty/campaigns/`Alternate route: `/v1/sovereignty/campaigns/`---This route is cached for up to 5 seconds
get   Shows sovereignty information for solar systems---Alternate route: `/dev/sovereignty/map/`Alternate route: `/legacy/sovereignty/map/`Alternate route: `/v1/sovereignty/map/`---This route is cached for up to 3600 seconds
get   Shows sovereignty data for structures.---Alternate route: `/dev/sovereignty/structures/`Alternate route: `/legacy/sovereignty/structures/`Alternate route: `/v1/sovereignty/structures/`---This route is cached for up to 120 seconds
get   EVE Server status---Alternate route: `/dev/status/`Alternate route: `/legacy/status/`Alternate route: `/v1/status/`---This route is cached for up to 30 seconds
put   Set a solar system as autopilot waypoint---Alternate route: `/dev/ui/autopilot/waypoint/`Alternate route: `/v2/ui/autopilot/waypoint/`
post   Open the contract window inside the client---Alternate route: `/dev/ui/openwindow/contract/`Alternate route: `/legacy/ui/openwindow/contract/`Alternate route: `/v1/ui/openwindow/contract/`
post   Open the information window for a character, corporation or alliance inside the client---Alternate route: `/dev/ui/openwindow/information/`Alternate route: `/legacy/ui/openwindow/information/`Alternate route: `/v1/ui/openwindow/information/`
post   Open the market details window for a specific typeID inside the client---Alternate route: `/dev/ui/openwindow/marketdetails/`Alternate route: `/legacy/ui/openwindow/marketdetails/`Alternate route: `/v1/ui/openwindow/marketdetails/`
post   Open the New Mail window, according to settings from the request if applicable---Alternate route: `/dev/ui/openwindow/newmail/`Alternate route: `/legacy/ui/openwindow/newmail/`Alternate route: `/v1/ui/openwindow/newmail/`
get   Get all character ancestries---Alternate route: `/dev/universe/ancestries/`Alternate route: `/legacy/universe/ancestries/`Alternate route: `/v1/universe/ancestries/`---This route expires daily at 11:05
get   Get information on an asteroid belt---Alternate route: `/dev/universe/asteroid_belts/{asteroid_belt_id}/`Alternate route: `/legacy/universe/asteroid_belts/{asteroid_belt_id}/`Alternate route: `/v1/universe/asteroid_belts/{asteroid_belt_id}/`---This route expires daily at 11:05
get   Get a list of bloodlines---Alternate route: `/dev/universe/bloodlines/`Alternate route: `/legacy/universe/bloodlines/`Alternate route: `/v1/universe/bloodlines/`---This route expires daily at 11:05
get   Get a list of item categories---Alternate route: `/dev/universe/categories/`Alternate route: `/legacy/universe/categories/`Alternate route: `/v1/universe/categories/`---This route expires daily at 11:05
get   Get information of an item category---Alternate route: `/dev/universe/categories/{category_id}/`Alternate route: `/legacy/universe/categories/{category_id}/`Alternate route: `/v1/universe/categories/{category_id}/`---This route expires daily at 11:05
get   Get a list of constellations---Alternate route: `/dev/universe/constellations/`Alternate route: `/legacy/universe/constellations/`Alternate route: `/v1/universe/constellations/`---This route expires daily at 11:05
get   Get information on a constellation---Alternate route: `/dev/universe/constellations/{constellation_id}/`Alternate route: `/legacy/universe/constellations/{constellation_id}/`Alternate route: `/v1/universe/constellations/{constellation_id}/`---This route expires daily at 11:05
get   Get a list of factions---Alternate route: `/dev/universe/factions/`Alternate route: `/v2/universe/factions/`---This route expires daily at 11:05
get   Get a list of graphics---Alternate route: `/dev/universe/graphics/`Alternate route: `/legacy/universe/graphics/`Alternate route: `/v1/universe/graphics/`---This route expires daily at 11:05
get   Get information on a graphic---Alternate route: `/dev/universe/graphics/{graphic_id}/`Alternate route: `/legacy/universe/graphics/{graphic_id}/`Alternate route: `/v1/universe/graphics/{graphic_id}/`---This route expires daily at 11:05
get   Get a list of item groups---Alternate route: `/dev/universe/groups/`Alternate route: `/legacy/universe/groups/`Alternate route: `/v1/universe/groups/`---This route expires daily at 11:05
get   Get information on an item group---Alternate route: `/dev/universe/groups/{group_id}/`Alternate route: `/legacy/universe/groups/{group_id}/`Alternate route: `/v1/universe/groups/{group_id}/`---This route expires daily at 11:05
post   Resolve a set of names to IDs in the following categories: agents, alliances, characters, constellations, corporations factions, inventory_types, regions, stations, and systems. Only exact matches will be returned. All names searched for are cached for 12 hours---Alternate route: `/dev/universe/ids/`Alternate route: `/legacy/universe/ids/`Alternate route: `/v1/universe/ids/`
get   Get information on a moon---Alternate route: `/dev/universe/moons/{moon_id}/`Alternate route: `/legacy/universe/moons/{moon_id}/`Alternate route: `/v1/universe/moons/{moon_id}/`---This route expires daily at 11:05
post   Resolve a set of IDs to names and categories. Supported ID's for resolving are: Characters, Corporations, Alliances, Stations, Solar Systems, Constellations, Regions, Types---Alternate route: `/dev/universe/names/`Alternate route: `/v2/universe/names/`
get   Get information on a planet---Alternate route: `/dev/universe/planets/{planet_id}/`Alternate route: `/legacy/universe/planets/{planet_id}/`Alternate route: `/v1/universe/planets/{planet_id}/`---This route expires daily at 11:05
get   Get a list of character races---Alternate route: `/dev/universe/races/`Alternate route: `/legacy/universe/races/`Alternate route: `/v1/universe/races/`---This route expires daily at 11:05
get   Get a list of regions---Alternate route: `/dev/universe/regions/`Alternate route: `/legacy/universe/regions/`Alternate route: `/v1/universe/regions/`---This route expires daily at 11:05
get   Get information on a region---Alternate route: `/dev/universe/regions/{region_id}/`Alternate route: `/legacy/universe/regions/{region_id}/`Alternate route: `/v1/universe/regions/{region_id}/`---This route expires daily at 11:05
get   Get information on a planetary factory schematic---Alternate route: `/dev/universe/schematics/{schematic_id}/`Alternate route: `/legacy/universe/schematics/{schematic_id}/`Alternate route: `/v1/universe/schematics/{schematic_id}/`---This route is cached for up to 3600 seconds
get   Get information on a stargate---Alternate route: `/dev/universe/stargates/{stargate_id}/`Alternate route: `/legacy/universe/stargates/{stargate_id}/`Alternate route: `/v1/universe/stargates/{stargate_id}/`---This route expires daily at 11:05
get   Get information on a star---Alternate route: `/dev/universe/stars/{star_id}/`Alternate route: `/legacy/universe/stars/{star_id}/`Alternate route: `/v1/universe/stars/{star_id}/`---This route expires daily at 11:05
get   Get information on a station---Alternate route: `/dev/universe/stations/{station_id}/`Alternate route: `/v2/universe/stations/{station_id}/`---This route expires daily at 11:05
get   List all public structures---Alternate route: `/dev/universe/structures/`Alternate route: `/legacy/universe/structures/`Alternate route: `/v1/universe/structures/`---This route is cached for up to 3600 seconds
get   Returns information on requested structure if you are on the ACL. Otherwise, returns "Forbidden" for all inputs.---Alternate route: `/dev/universe/structures/{structure_id}/`Alternate route: `/v2/universe/structures/{structure_id}/`---This route is cached for up to 3600 seconds
get   Get the number of jumps in solar systems within the last hour ending at the timestamp of the Last-Modified header, excluding wormhole space. Only systems with jumps will be listed---Alternate route: `/dev/universe/system_jumps/`Alternate route: `/legacy/universe/system_jumps/`Alternate route: `/v1/universe/system_jumps/`---This route is cached for up to 3600 seconds
get   Get the number of ship, pod and NPC kills per solar system within the last hour ending at the timestamp of the Last-Modified header, excluding wormhole space. Only systems with kills will be listed---Alternate route: `/dev/universe/system_kills/`Alternate route: `/v2/universe/system_kills/`---This route is cached for up to 3600 seconds
get   Get a list of solar systems---Alternate route: `/dev/universe/systems/`Alternate route: `/legacy/universe/systems/`Alternate route: `/v1/universe/systems/`---This route expires daily at 11:05
get   Get information on a solar system.---Alternate route: `/dev/universe/systems/{system_id}/`Alternate route: `/v4/universe/systems/{system_id}/`---This route expires daily at 11:05
get   Get a list of type ids---Alternate route: `/dev/universe/types/`Alternate route: `/legacy/universe/types/`Alternate route: `/v1/universe/types/`---This route expires daily at 11:05
get   Get information on a type---Alternate route: `/dev/universe/types/{type_id}/`Alternate route: `/v3/universe/types/{type_id}/`---This route expires daily at 11:05
get   Return a list of wars---Alternate route: `/dev/wars/`Alternate route: `/legacy/wars/`Alternate route: `/v1/wars/`---This route is cached for up to 3600 seconds
get   Return details about a war---Alternate route: `/dev/wars/{war_id}/`Alternate route: `/legacy/wars/{war_id}/`Alternate route: `/v1/wars/{war_id}/`---This route is cached for up to 3600 seconds
get   Return a list of kills related to a war---Alternate route: `/dev/wars/{war_id}/killmails/`Alternate route: `/legacy/wars/{war_id}/killmails/`Alternate route: `/v1/wars/{war_id}/killmails/`---This route is cached for up to 3600 seconds
get   This endpoint contains Final Audit Reports approved by the Commission since inception.The search can be based on information about the audited committee (Name, FEC ID Number, Type, Election Cycle) or the issues covered in the report.
get   This lists the options for the categories and subcategories available in the /audit-search/ endpoint.
get   This lists the options for the primary categories available in the /audit-search/ endpoint.
invalid   Combines the election and reporting dates with Commission meetings, conferences, outreach, Advisory Opinions, rules, litigation dates and otherevents into one calendar.State and report type filtering is no longer available.
get   Returns CSV or ICS for downloading directly into calendar applications like Google, Outlook or other applications.Combines the election and reporting dates with Commission meetings, conferences, outreach, Advisory Opinions, rules, litigation dates and otherevents into one calendar.State filtering now applies to elections, reports and reporting periods.Presidential pre-primary report due dates are not shown on even years.Filers generally opt to file monthly rather than submit over 50 pre-primary electionreports. All reporting deadlines are available at /reporting-dates/ for reference.This is [the sql function](https://github.com/fecgov/openFEC/blob/develop/data/migrations/V40__omnibus_dates.sql)that creates the calendar.
get   This endpoint is useful for finding detailed information about a particular candidate. Use the`candidate_id` to find the most recent information about that candidate.
get   This endpoint is useful for finding detailed information about a particular committee orfiler. Use the `committee_id` to find the most recent information about the committee.
post   Explore a filer's characteristics over time. This can be particularly useful if thecommittees change treasurers, designation, or `committee_type`.
post   Explore a filer's characteristics over time. This can be particularly useful if thecommittees change treasurers, designation, or `committee_type`.
get   All official records and reports filed by or delivered to the FEC.Note: because the filings data includes many records, counts for largeresult sets are approximate; you will want to page through the records until no records are returned.
get   Find out a candidate's characteristics over time. This is particularly useful if thecandidate runs for the same office in different districts or you want to know more about a candidate'sprevious races.This information is organized by `candidate_id`, so it won't help you find a candidatewho ran for different offices over time; candidates get a new ID for each office.
get   Find out a candidate's characteristics over time. This is particularly useful if thecandidate runs for the same office in different districts or you want to know more about a candidate'sprevious races.This information is organized by `candidate_id`, so it won't help you find a candidatewho ran for different offices over time; candidates get a new ID for each office.
get   This endpoint provides information about a committee's Form 3, Form 3X, or Form 3P financial reports,which are aggregated by two-year period. We refer to two-year periods as a `cycle`.The cycle is named after the even-numbered year and includes the year before it. To obtaintotals from 2013 and 2014, you would use 2014. In odd-numbered years, the current cycleis the next year � for example, in 2015, the current cycle is 2016.For presidential and Senate candidates, multiple two-year cycles exist between elections.
post   Fetch basic information about candidates, and use parameters to filter results to thecandidates you're looking for.Each result reflects a unique FEC candidate ID. That ID is particular to the candidate for aparticular office sought. If a candidate runs for the same office multiple times, the IDstays the same. If the same person runs for another office � for example, a Housecandidate runs for a Senate office � that candidate will get a unique ID for each office.
post   Fetch basic information about candidates and their principal committees.Each result reflects a unique FEC candidate ID. That ID is assigned to the candidate for aparticular office sought. If a candidate runs for the same office over time, that IDstays the same. If the same person runs for multiple offices � for example, a Housecandidate runs for a Senate office � that candidate will get a unique ID for each office.The candidate endpoints primarily use data from FEC registration[Form 1](http://www.fec.gov/pdf/forms/fecfrm1.pdf) for committee information and[Form 2](http://www.fec.gov/pdf/forms/fecfrm2.pdf) for candidate information.
get   Aggregated candidate receipts and disbursements grouped by cycle.
get    Aggregated candidate receipts and disbursements grouped by office by cycle.
get    Aggregated candidate receipts and disbursements grouped by office by party by cycle.
get   This endpoint is useful for finding detailed information about a particular committee orfiler. Use the `committee_id` to find the most recent information about the committee.
get   This endpoint is useful for finding detailed information about a particular candidate. Use the`candidate_id` to find the most recent information about that candidate.
get   Find out a candidate's characteristics over time. This is particularly useful if thecandidate runs for the same office in different districts or you want to know more about a candidate'sprevious races.This information is organized by `candidate_id`, so it won't help you find a candidatewho ran for different offices over time; candidates get a new ID for each office.
get   Find out a candidate's characteristics over time. This is particularly useful if thecandidate runs for the same office in different districts or you want to know more about a candidate'sprevious races.This information is organized by `candidate_id`, so it won't help you find a candidatewho ran for different offices over time; candidates get a new ID for each office.
get   All official records and reports filed by or delivered to the FEC.Note: because the filings data includes many records, counts for largeresult sets are approximate; you will want to page through the records until no records are returned.
post   Explore a filer's characteristics over time. This can be particularly useful if thecommittees change treasurers, designation, or `committee_type`.
post   Explore a filer's characteristics over time. This can be particularly useful if thecommittees change treasurers, designation, or `committee_type`.
get   Each report represents the summary information from Form 3, Form 3X and Form 3P.These reports have key statistics that illuminate the financial status of a given committee.Things like cash on hand, debts owed by committee, total receipts, and total disbursementsare especially helpful for understanding a committee's financial dealings.By default, this endpoint includes both amended and final versions of each report. To restrictto only the final versions of each report, use `is_amended=false`; to retrieve only reports thathave been amended, use `is_amended=true`.Several different reporting structures exist, depending on the type of organization thatsubmits financial information. To see an example of these reporting requirements,look at the summary and detailed summary pages of Form 3, Form 3X, and Form 3P.DISCLAIMER: The field labels contained within this resource are subject to change.  We are attempting to succinctlylabel these fields while conveying clear meaning to ensure accessibility for all users.
get   This endpoint provides information about a committee's Form 3, Form 3X, or Form 3P financial reports,which are aggregated by two-year period. We refer to two-year periods as a `cycle`.The cycle is named after the even-numbered year and includes the year before it. To obtaintotals from 2013 and 2014, you would use 2014. In odd-numbered years, the current cycleis the next year � for example, in 2015, the current cycle is 2016.For presidential and Senate candidates, multiple two-year cycles exist between elections.
get   Fetch basic information about committees and filers. Use parameters to filter forparticular characteristics.
get   52 U.S.C. 30118 allows "communications by a corporation to its stockholders and executive or administrative personnel and their families or by a labor organization to its members and their families on any subject," including the express advocacy of the election or defeat of any Federal candidate.  The costs of such communications must be reported to the Federal Election Commission under certain circumstances.
get   Communication cost aggregated by candidate ID and committee ID.
get   Communication cost aggregated by candidate ID and committee ID.
get   Total communications costs aggregated across committees on supported or opposed candidates by cycle or candidate election year.
get   Basic information about electronic files coming into the FEC, posted as they are received.
get   Key financial data reported periodically by committees as they are reported. This feed includes summaryinformation from the the House F3 reports, the presidential F3p reports and the PAC and partyF3x reports.Generally, committees file reports on a quarterly or monthly basis, butsome must also submit a report 12 days before primary elections. Therefore, during the primaryseason, the period covered by this file may be different for different committees. These totalsalso incorporate any changes made by committees, if any report covering the period is amended.DISCLAIMER: The field labels contained within this resource are subject to change.  We are attempting to succinctlylabel these fields while conveying clear meaning to ensure accessibility for all users.
get   Key financial data reported periodically by committees as they are reported. This feed includes summaryinformation from the the House F3 reports, the presidential F3p reports and the PAC and partyF3x reports.Generally, committees file reports on a quarterly or monthly basis, butsome must also submit a report 12 days before primary elections. Therefore, during the primaryseason, the period covered by this file may be different for different committees. These totalsalso incorporate any changes made by committees, if any report covering the period is amended.DISCLAIMER: The field labels contained within this resource are subject to change.  We are attempting to succinctlylabel these fields while conveying clear meaning to ensure accessibility for all users.
get   Key financial data reported periodically by committees as they are reported. This feed includes summaryinformation from the the House F3 reports, the presidential F3p reports and the PAC and partyF3x reports.Generally, committees file reports on a quarterly or monthly basis, butsome must also submit a report 12 days before primary elections. Therefore, during the primaryseason, the period covered by this file may be different for different committees. These totalsalso incorporate any changes made by committees, if any report covering the period is amended.DISCLAIMER: The field labels contained within this resource are subject to change.  We are attempting to succinctlylabel these fields while conveying clear meaning to ensure accessibility for all users.
get   FEC election dates since 1995.
get   An electioneering communication is any broadcast, cable or satellite communication that fulfills each of the following conditions:_The communication refers to a clearly identified federal candidate.__The communication is publicly distributed by a television station, radio station, cable television system or satellite system for a fee.__The communication is distributed within 60 days prior to a general election or 30 days prior to a primary election to federal office._
get   Electioneering communications costs aggregates
get   Electioneering costs aggregated by candidate
get   Total electioneering communications spent on candidates by cycleor candidate election year
get   Look at the top-level financial information for all candidates running for the sameoffice.Choose a 2-year cycle, and `house`, `senate` or `presidential`.If you are looking for a Senate seat, you will need to select the state using a two-letterabbreviation.House races require state and a two-digit district number.Since this endpoint reflects financial information, it will only have candidates once they filefinancial reporting forms. Query the `/candidates` endpoint to retrieve an-up-to-date list of all thecandidates that filed to run for a particular seat.
get   List elections by cycle, office, state, and district.
get   List elections by cycle, office, state, and district.
get   All official records and reports filed by or delivered to the FEC.Note: because the filings data includes many records, counts for largeresult sets are approximate; you will want to page through the records until no records are returned.
get   Search legal documents by document type, or across all document types using keywords, parameter values and ranges.
get   Search for candidates or committees by name. If you're looking for information on aparticular person or group, using a name to find the `candidate_id` or `committee_id` onthis endpoint can be a helpful first step.
get   Search for candidates or committees by name. If you're looking for information on aparticular person or group, using a name to find the `candidate_id` or `committee_id` onthis endpoint can be a helpful first step.
get   Search for candidates or committees by name. If you're looking for information on aparticular person or group, using a name to find the `candidate_id` or `committee_id` onthis endpoint can be a helpful first step.
get   Search for candidates or committees by name. If you're looking for information on aparticular person or group, using a name to find the `candidate_id` or `committee_id` onthis endpoint can be a helpful first step.
get   The Operations log contains details of each report loaded into the database. It is primarilyused as status check to determine when all of the data processes, from initial entry throughreview are complete.
get   Net receipts per candidate.Filter with `contributor_state='US'` for national totals
get   Contribution receipts by size per candidate.Filter by candidate_id, election_year and/or size
get   Contribution receipts by state per candidate.Filter by candidate_id and/or election_year
get   Coverage end date per candidate.Filter by candidate_id and/or election_year
get   Financial summary per candidate.Filter by candidate_id and/or election_year
get   Use this endpoint to look up the RAD Analyst for a committee.The mission of the Reports Analysis Division (RAD) is to ensure thatcampaigns and political committees file timely and accurate reports that fully disclosetheir financial activities.  RAD is responsible for reviewing statements and financialreports filed by political committees participating in federal elections, providingassistance and guidance to the committees to properly file their reports, and for takingappropriate action to ensure compliance with the Federal Election Campaign Act (FECA).
get   FEC election dates since 1995.
get   Each report represents the summary information from Form 3, Form 3X and Form 3P.These reports have key statistics that illuminate the financial status of a given committee.Things like cash on hand, debts owed by committee, total receipts, and total disbursementsare especially helpful for understanding a committee's financial dealings.By default, this endpoint includes both amended and final versions of each report. To restrictto only the final versions of each report, use `is_amended=false`; to retrieve only reports thathave been amended, use `is_amended=true`.Several different reporting structures exist, depending on the type of organization thatsubmits financial information. To see an example of these reporting requirements,look at the summary and detailed summary pages of Form 3, Form 3X, and Form 3P.DISCLAIMER: The field labels contained within this resource are subject to change.  We are attempting to succinctlylabel these fields while conveying clear meaning to ensure accessibility for all users.
get   Returns all your fire.com Accounts. Ordered by Alias ascending. Can be paginated.
post   Creates a new fire.com account.**Please note there is a charge associated with creating a new account.**
get   You can retrieve the details of a fire.com Account by its `ican`.
get   Retrieve a list of transactions against an account.
get   Retrieve a filtered list of transactions against an account.* `dateRangeFrom` - A millisecond epoch time specifying the date range start date.* `dateRangeTo` - A millisecond epoch time specifying the date range end date.* `searchKeyword` - Search term to filter by from the reference field (`myRef`).* `transactionTypes` - One or more of the transaction types above. This field can be repeated multiple times to allow for multiple transaction types.
post   Create a new API Application with specified permissions
post   Authenticate with the API.
get   Returns all ASPSPs (Account Servicing Payment Service Provider) / banks. The list can be filtered by currency. You will need to enable the `PERM_BUSINESS_GET_ASPSPS` permission to use this endpoint.***This endpoint is only required if you intend to host the �Select ASPSP / bank� page yourself.***
get   Returns the list of batch with the specified types and statuses.
post   This is the first step in creating a batch payment.
post   Submits the Batch (for approval in the case of a **BANK_TRANSFER**). If this is an **INTERNAL_TRANSFER** batch, the transfers are immediately queued for processing. If this is a **BANK_TRANSFER** batch, this will trigger requests for approval to the firework mobile apps of authorised users. Once those users approve the batch, it is queued for processing.You can only submit a batch while it is in the OPEN state.
delete   Cancels the Batch. You can only cancel a batch before it is submitted for approval (while it is in the OPEN state).
get   Returns the details of the batch specified in the API endpoint - {batchUuid}.
get   Returns a list of approvers for this batch.
get   Returns a paginated list of items in the specified batch.
post   There are two ways to process bank transfers - by Payee ID (**Mode 1**) or by Payee Account Details (**Mode 2**).**Mode 1:** Use the payee IDs of existing approved payees set up against your account. These batches can be approved in the normal manner.**Mode 2:** Use the account details of the payee. In the event that these details correspond to an existing approved payee, the batch can be approved as normal. If the account details are new, a batch of New Payees will automatically be created. This batch will need to be approved before the Payment batch can be approved. These payees will then exist as approved payees for future batches.
delete   Removes a Payment from the Batch (Bank Transfers). You can only remove payments before the batch is submitted for approval (while it is in the OPEN state).
get   Returns a paginated list of items in the specified batch.
post   Simply specify the source account, destination account, amount and a reference.
delete   Removes a Payment from the Batch (Internal Transfer). You can only remove payments before the batch is submitted for approval (while it is in the OPEN state).
get   Returns a list of cards related to your fire.com account.
post   You can create multiple debit cards which can be linked to your fire.com accounts.
get   Retrieve all direct debit payments associated with a direct debit mandate.The permision needed to access this endpoint is PERM_BUSINESS_GET_DIRECT_DEBITS
get   Retrieve all details of a single direct debit collection/payment, whether successful or not.The permision needed to access this endpoint is **PERM_BUSINESS_GET_DIRECT_DEBIT**
post   This endpoint allows you to reject a direct debit payment where the status is still set to RECEIVED.Permission name PERM_BUSINESS_POST_DIRECT_DEBIT_REJECT
get   The permision needed to access this endpoint is PERM_BUSINESS_GET_MANDATES
get   Retrieve all details for a direct debit mandate.The permision needed to access this endpoint is PERM_BUSINESS_GET_MANDATE
put   Update Direct Debit Mandate AliasThe permision needed to access this endpoint is PERM_BUSINESS_PUT_MANDATE
post   This endpoint can only be used to activate a direct debit mandate when it is in the status REJECT_REQUESTED (even if the account has direct debits disabled). This action will also enable the account for direct debits if it was previously set to be disabled.The permision needed to access this endpoint is PERM_BUSINESS_POST_MANDATE_ACTIVATE
post   This endpoint allows you to cancel a direct debit mandate.The permision needed to access this endpoint is PERM_BUSINESS_POST_MANDATE_CANCEL
get   Returns all your payee bank accounts. Ordered by date added descending. Can be paginated.
post   Creates a new Fire Open Payment Payment request. A code is returned that can be shared to your customers as a URL by any channel you wish.You will need to enable the `PERM_BUSINESS_POST_PAYMENT_REQUEST` permission to use this endpoint.
get   Returns the details of a specific payment.As the customer goes through the process of making the payment the status of the payment will change.* `AWAITING_AUTHORISATION` -This is the initial status of all your payments.* `AUTHORISED` - This is the status that your payment is set to after the customer has authorised the payment with their ASPSP / bank.* `AWAITING_MULTI_AUTHORISATION` - Some business accounts such as charities require dual authorisation.* `NOT_AUTHORISED` - Either your customer clicked on cancel or the payment was rejected by their ASPSP / bank.* `PENDING` - This is the status that your payment is set to after the customer has authorised the payment with their ASPSP / bank but the bank may want to carry out another check before funding the transaction.* `PAID` - Funds were received into your fire.com GBP or EUR account from your customer�s ASPSP / bank.You will need to enable the `PERM_BUSINESS_GET_PAYMENT` permission to use this endpoint.
get   You can retrieve the details of a specific fire.com user
get   You can retrieve the details of all fire.com users on your acount.
get   Retrieves the Billing Details.
put   Updates the Billing Details.
post   Adds/Overwrites the user entry in the access control database.
delete   Using '*' for user clears all the users.
get   If nothing is specified then this returns "".
get   If nothing is specified in admin/settings.cfg then returns "". If no admin directory is specified then the shared area will be used where needed (e.g. for persistent info, access control data files etc. )
get   If nothing is specified in admin/settings.cfg then returns "".
get   0 indicates that it is disabled, 1 indicates it is enabled.
get   Each entry consists of user, agents (in minimal range representation) and access mask (not used currently).
put   If filename is not specified then the currently set 'acldb' parameter is used.
put   If filename is not specified then the currently set 'acldb' parameter is used.
put   This will be used for subsequent load and save operations.
put   0 indicates disabled, 1 indicates enabled.
post   Add an agent.
post   An empty ipaddress or 0.0.0.0 both imply any address. Similarly an empty port or 0 both imply any port. For agents with source-address-indexing enabled, messages which do not match any source address will be discarded with an ERROR message, similar to community string mismatches.
get   This in effect implements source-address-indexing, where 2 agents with the same address can be configured, each accepting messages from different management stations.
get   has the agent value space changed?
get   has the lab configuration changed?
get   The minimum granularity is 10 msec.
get   drop rate (every N-th PDU). 0 means no drops.
get   Currently, only IPv4 addresses are allowed as the main address of the agent, but both IPv4 and IPv6 addresses are allowed as IP aliases for the agent.
get   The agent will retransmit INFORM PDUs at this interval until it has received a reply from the manager.
get   network interface card for the agent.
get   subnet mask of the agent.
get   set of MIBs, simulations and scenarios
get   This count is incremented each time an agent starts. It affects the SNMPv3 EngineBoots parameter.
get   MIB directory of the agent.
get   owner of the agent.
get   The limit for this configurable is 65536.
get   port number
get   private directory of the agent.
get   protocols supported by agent as an array of strings
get   read community string
get   first scenario name
get   first simulation name
get   relative start time
get   0-Unknown 1-Running 2-Stopped 3-Halted 4-Paused 5-Deleted 6-Stopping
get   has the agent state changed?
get   The statistics are returned as 64-bit decimal numbers for the following statistics, total, discarded, error, GET, GETNEXT, SET, GETBULK, trap, GET variables, GETNEXT variables, SET variables, GETBULK variables, INFORM sent, INFORM re-sent, INFORM timed out, INFORM acked, INFORM REPORT
get   SNMP PDU tracing
get   Is a bitmask in which with the following bits (from LSB) check for type, length, range, access
get   write community string
put   Halt the current agent.
post   port defaults to 161 if not specified. mask defaults to the class-based network mask for the address. interface defaults to the default network interface.  If port is set to 0, the system will automatically select a port number. This is useful for client-mode protocols, such as TFTP or TOD. Upon start of an IP alias with a 0 (auto-assigned) port number, its port will change to contain the value of the selected system port.
put   port defaults to 161 if not specified.
get   The agent host address (set with mimic agent set host) is not in this list, since it is already accessible separately with mimic agent get host.
put   port defaults to 161 if not specified.
put   port defaults to 161 if not specified.
put   port defaults to 161 if not specified.
post   Pause the current agent.
get   Agent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap
get   Agent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap
get   Statistics of fields indicated in the headers
get   Trace 1 means enabled, 0 means not
put   Agent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap
put   1 to enable, 0 to disable
get   Agent's DHCP configuration particulars
get   Agent's DHCP configuration hwaddr,classid,add_options,script
get   Statistics of fields indicated in the headers
put   Trace 1 means enabled, 0 means not
put   DHCP-OFFER message parameters
put   Agent's DHCP configuration with port,rule,prompt,paging_prompt,userdb,keymap
put   1 to enable, 0 to disable
get   Agent's IPMI configuration with port,rule,prompt,paging_prompt,userdb,keymap
get   Agent's IPMI configuration with port,rule,prompt,paging_prompt,userdb,keymap
get   Statistics of fields indicated in the headers
put   Trace 1 means enabled, 0 means not
get   Attribute can be working_authtype ,session_id, outbound_seq, inbound_seq , field_N
put   Agent's IPMI configuration with port,rule,prompt,paging_prompt,userdb,keymap
put   1 to enable, 0 to disable
put   Attribute can be working_authtype ,session_id, outbound_seq, inbound_seq , field_N
put   0 - stopped, 2 - disconnected, 3 - connecting, 4 - connected, 5 - waiting for CONNACK, 6 - waiting for SUBACK, 7 - CONNACK received, in steady state
put   0 means stopped, 1 means running
put   0 or more
put   By default, the MIMIC SNMPTCP server listens on all the IP addresses (aliases) that are configured for an agent
put   By default, the MIMIC SNMPTCP server listens on all the IP addresses (aliases) that are configured for an agent
get   By default, the MIMIC SNMPTCP server listens on all the IP addresses (aliases) that are configured for an agent
get   By default, the MIMIC SNMPTCP server listens on all the IP addresses (aliases) that are configured for an agent
put   Agent's SNMPTCP configuration with port,rule,prompt,paging_prompt,userdb,keymap
put   1 to enable, 0 to disable
post   Adds a new access entry with the specified parameters.
delete   Clears all access entries.
delete   Deletes the specified access entry.
get   Returns the current acccess entries as an array of strings.
get   Returns the SNMPv3 configuration.
get   Retrieves the contextEngineID for the agent instance.
get   Retrieves the number of times the agent has been restarted.
get   For stopped agents, this operation is meaningless. If not explicitly set by the user then the autogenerated engineID is returned. The format of the engineID is in the familiar hex format, eg. \x01 23 45 67 89...
get   Retrieves the time in seconds for which the agent has been running.
post   Adds a new group entry with the specified parameters.
delete   Clears all group entries.
delete   Deletes the specified group entry.
get   Returns the current group entries as an array of strings.
put   Changes the SNMPv3 configuration.
post   Adds a new user entry with the specified parameters.
delete   Clears all user entries.
delete   Deletes the specified user entry.
get   Returns the current user entries as a Tcl list.
put   Saves current user settings in the currently loaded USM config file.
put   Saves current user settings in the specified USM config file.
put   Saves current group, access, view settings in the currently loaded VACM config file.
put   Saves current group, access, view settings in the specified VACM config file.
post   Adds a new view entry with the specified parameters.
delete   Clears all view entries.
delete   Deletes the specified view entry.
get   Returns the current view entries as an array of strings.
get   Agent's SSH configuration with port,rule,prompt,paging_prompt,userdb,keymap
get   Agent's SSH configuration with port,rule,prompt,paging_prompt,userdb,keymap
get   Statistics of fields indicated in the headers
get   Trace 1 means enabled, 0 means not
put   By default, the MIMIC SSH server listens on all the IP addresses (aliases) that are configured for an agent
put   By default, the MIMIC SSH server listens on all the IP addresses (aliases) that are configured for an agent
get   By default, the MIMIC SSH server listens on all the IP addresses (aliases) that are configured for an agent
get   By default, the MIMIC SSH server listens on all the IP addresses (aliases) that are configured for an agent
put   Agent's SSH configuration with port,rule,prompt,paging_prompt,userdb,keymap
put   1 to enable, 0 to disable
post   Add port
get   Check the port. 1 means existing, 0 means not
delete   Remove port
put   Set port
post   Start port
post   Stop port
put   Agent's WEB configuration with port,rule,prompt,paging_prompt,userdb,keymap
put   1 to enable, 0 to disable
get   Returns the protocol's configuration.
put   This only works for halted agents. The net effect is the same as restarting an agent (ie. stop, start, halt), but without disconnecting the network (and thus existing connections).
post   Resume the current agent.
put   Save agent MIB values.
post   Add a new timer script to be executed at specified interval (in msec) with the specified argument.
delete   The first scheduled script that matches the script name, and optionally the interval and argument will be deleted.
get   The command mimic timer script list lists global timer scripts, the command /mimic/timer/script/{agentNum}/list is the per-agent equivalent NOTE Global timer scripts run globally but within them you can address individual agents using {agentNum}. To schedule timerscripts for an individual agent, use /mimic/timer/script/{agentNum}.
post   Add a trap destination to the set of destinations.
delete   Remove a trap destination from the set of destinations.
get   Each trap destination is identified with an IP address and a port number. The default port number is the standard SNMP trap port 162.
get   List the outstanding asynchronous traps for this agent instance.
put   Save the lab configuration.
put   Save the lab configuration in file.
post   Add a new timer script to be executed at specified interval (in msec) with the specified argument.
delete   The first scheduled script that matches the script name, and optionally the interval and argument will be deleted.
get   The command mimic timer script list lists global timer scripts, the command /mimic/timer/script/{agentNum}/list is the per-agent equivalent NOTE Global timer scripts run globally but within them you can address individual agents using {agentNum}. To schedule timerscripts for an individual agent, use /mimic/timer/script/{agentNum}.
delete   This does not delete the repository, it only removes the repository from the team.
get   Get the current application settings
put   Modify application settings
post   Validation of .gitlab-ci.yml content
get   Get a groups list
post   Create a group. Available only for users who can create groups.
get   Get list of owned groups for authenticated user
delete   Remove a group.
get   Get a single group, with containing projects.
put   Update a group. Available only for users who can administrate groups.
get   Get a list of group issues
get   Gets a list of group or project members viewable by the authenticated user.
post   Adds a member to a group or project.
delete   Removes a user from a group or project.
get   Gets a member of a group or project.
put   Updates a member of a group or project.
get   Get a list of projects in this group.
post   Transfer a project to the group namespace. Available only for admin.
get   Get the list of system hooks
post   Create a new system hook
delete   Delete a hook
post   Test a hook
get   Get currently authenticated user's issues
get   Get single ssh key by id. Only available to admin users
get   Get a namespaces list
get   Get a projects list for authenticated user
post   Create new project
get   Get all projects for admin user
post   Fork new project for the current user or provided namespace.
get   Get an owned projects list for authenticated user
get   Search for projects the current user has access to
get   Gets starred project for the authenticated user
post   Create new project for a specified user. Only available to admin users.
get   Get a list of visible projects for authenticated user
delete   Remove a project
get   Get a single project
put   Update an existing project
post   Trigger a GitLab project build
post   Archive a project
get   Get a project builds
get   Get a specific build of a project
post   Keep the artifacts to prevent them from being deleted
post   Cancel a specific build of a project
delete   Erase build (remove artifacts and build trace)
post   Retry a specific build of a project
get   Get a trace of a specific build of a project
get   Get a specific project's deploy keys
post   Add new deploy key to currently authenticated user
delete   Delete deploy key for a project
get   Get single deploy key
get   Get events for a single project
delete   Remove a forked_from relationship
post   Mark this project as forked from another
get   Get project hooks
post   Add hook to project
delete   Deletes project hook
get   Get a project hook
put   Update an existing project hook
get   Get a list of project issues
post   Create a new project issue
delete   Delete a project issue
get   Get a single project issue
put   Update an existing issue
post   Add spent time for a project issue
post   Move an existing issue
post   Reset spent time for a project issue
post   Reset the time estimate for a project issue
post   Set a time estimate for a project issue
get   Show time stats for a project issue
post   Create a todo on an issuable
get   Get a list of project +noteable+ notes
post   Create a new +noteable+ note
delete   Delete a +noteable+ note
get   Get a single +noteable+ note
put   Update an existing +noteable+ note
post   Unsubscribe from a resource
post   Subscribe to a resource
get   Get a specific project's deploy keys
post   Add new deploy key to currently authenticated user
delete   Delete deploy key for a project
get   Get single deploy key
delete   Delete an existing label
get   Get all labels of the project
post   Create a new label
put   Update an existing label. At least one optional parameter is required.
post   Unsubscribe from a resource
post   Subscribe to a resource
get   Gets a list of group or project members viewable by the authenticated user.
post   Adds a member to a group or project.
delete   Removes a user from a group or project.
get   Gets a member of a group or project.
put   Updates a member of a group or project.
put   Update a merge request
post   Cancel merge if "Merge When Pipeline Succeeds" is enabled
get   Show the merge request changes
get   List issues that will be closed on merge
get   Get the commits of a merge request
post   Merge a merge request
post   Unsubscribe from a resource
post   Subscribe to a resource
get   List merge requests
post   Create a merge request
delete   Delete a merge request
get   Get a single merge request
put   Update a merge request
post   Add spent time for a project merge_request
post   Cancel merge if "Merge When Pipeline Succeeds" is enabled
get   Show the merge request changes
get   List issues that will be closed on merge
get   Get the commits of a merge request
post   Merge a merge request
post   Reset spent time for a project merge_request
post   Reset the time estimate for a project merge_request
post   Set a time estimate for a project merge_request
get   Show time stats for a project merge_request
post   Create a todo on an issuable
get   Get a list of project +noteable+ notes
post   Create a new +noteable+ note
delete   Delete a +noteable+ note
get   Get a single +noteable+ note
put   Update an existing +noteable+ note
post   Unsubscribe from a resource
post   Subscribe to a resource
get   Get a list of project milestones
post   Create a new project milestone
get   Get a single project milestone
put   Update an existing project milestone
get   Get all issues for a single project milestone
get   Get an archive of the repository
get   Get a raw file contents
get   Get a project repository branches
post   Create branch
delete   Delete a branch
get   Get a single branch
post   Protect a single branch
post   Unprotect a single branch
get   Get a project repository commits
get   Get a specific commit of a project
get   Get a raw file contents
get   Get builds for a specific commit of a project
get   Get a commit's comments
post   Post comment to commit
get   Get the diff for a specific commit of a project
get   Get a commit's statuses
post   Compare two branches, tags, or commits
get   Get repository contributors
delete   Delete an existing file in repository
get   Get a file from repository
post   Create new file in repository
put   Update existing file in repository
get   Get a raw blob contents by blob sha
get   Get a project repository tags
post   Create a new repository tag
delete   Delete a repository tag
get   Get a single repository tag
post   Add a release note to a tag
put   Update a tag's release note
get   Get a project repository tree
get   Get runners available for project
post   Enable a runner for a project
post   Disable project's runner
put   Set asana service for project
put   Set assembla service for project
put   Set bamboo service for project
put   Set bugzilla service for project
put   Set buildkite service for project
put   Set builds-email service for project
put   Set campfire service for project
put   Set custom-issue-tracker service for project
put   Set drone-ci service for project
put   Set emails-on-push service for project
put   Set external-wiki service for project
put   Set flowdock service for project
put   Set gemnasium service for project
put   Set hipchat service for project
put   Set irker service for project
put   Set jira service for project
put   Set kubernetes service for project
put   Set mattermost service for project
put   Set mattermost-slash-commands service for project
put   Set pipelines-email service for project
put   Set pivotaltracker service for project
put   Set pushover service for project
put   Set redmine service for project
put   Set slack service for project
put   Set slack-slash-commands service for project
put   Set teamcity service for project
delete   Delete a service for project
get   Get the service settings for project
post   Share the project with a group
get   Get all project snippets
post   Create a new project snippet
get   Get a list of project +noteable+ notes
post   Create a new +noteable+ note
delete   Delete a +noteable+ note
get   Get a single +noteable+ note
put   Update an existing +noteable+ note
delete   Delete a project snippet
get   Get a single project snippet
put   Update an existing project snippet
get   Get a raw project snippet
post   Unstar a project
post   Star a project
post   Post status to a commit
get   Get triggers list
post   Create a trigger
delete   Delete a trigger
get   Get specific trigger of a project
post   Unarchive a project
post   Upload a file
get   Get the users list of a project
get   Get project variables
post   Create a new variable in a project
delete   Delete an existing variable from a project
get   Get a specific variable from a project
put   Update an existing variable from a project
get   Get runners available for user
get   Get all runners - shared and specific
delete   Remove a runner
get   Get runner's details
put   Update runner's details
post   Login to get token
get   Get the Sidekiq Compound metrics. Includes queue, process, and job statistics
get   Get the Sidekiq job statistics
get   Get the Sidekiq process metrics
get   Get the Sidekiq queue metrics
post   Mark all todos as done
get   Get a todo list
post   Mark a todo as done
get   Get the currently authenticated user
get   Get the currently authenticated user's email addresses
post   Add new email address to the currently authenticated user
delete   Delete an email address from the currently authenticated user
get   Get a single email address owned by the currently authenticated user
get   Get the currently authenticated user's SSH keys
post   Add a new SSH key to the currently authenticated user
delete   Delete an SSH key from the currently authenticated user
get   Get a single key owned by currently authenticated user
get   Get the list of users
post   Create a user. Available only for admins.
delete   Delete a user. Available only for admins.
get   Get a single user
put   Update a user. Available only for admins.
post   Block a user. Available only for admins.
get   Get the emails addresses of a specified user. Available only for admins.
post   Add an email address to a specified user. Available only for admins.
delete   Delete an email address of a specified user. Available only for admins.
get   Get the SSH keys of a specified user. Available only for admins.
post   Add an SSH key to a specified user. Available only for admins.
delete   Delete an existing SSH key from a specified user. Available only for admins.
post   Unblock a user. Available only for admins.
post   The Cluster endpoint is used with a POST request towards`https://graphhopper.com/api/1/cluster?key=<your_key>`. The solution will be provided in the JSON response.Please note that for problems that take longer than 10 seconds a bad request error is returned.In this case please use the asynchronous [Batch Cluster Endpoint](#operation/asyncClusteringProblem) instead.
post   Prefer the [synchronous endpoint](#operation/solveClusteringProblem) and use this Batch Cluster endpoint forlong running problems only. The work flow is asynchronous:- send a POST request towards `https://graphhopper.com/api/1/cluster/calculate?key=<your_key>` and fetch the job_id.- poll the solution every 500ms until it gives `status=finished`. Do this with a GET request  towards `https://graphhopper.com/api/1/cluster/solution/<job_id>?key=<your_key>`.
get   This endpoint returns the solution of the clustering problems submitted to the [Batch Cluster endpoint](#operation/asyncClusteringProblem).You can fetch it with the job_id, you have been sent.
post   ### Introduction![Geocoding Example](./img/geocoding-example.png)_Geocoding_ describes the process of transforming an textual address representation to a coordinate (`latitude,longitude`).For example the conversion from `Berlin` to `52.5170365,13.3888599`._Reverse geocoding_ converts a coordinate to a textual address representation or place name. Find out more about Geocoding itself on [Wikipedia](http://en.wikipedia.org/wiki/Geocoding).
get   ### ExampleYou can get an example response via:```curl "https://graphhopper.com/api/1/isochrone?point=51.131108,12.414551&key=[YOUR_KEY]"```Don't forget to replace the placeholder with your own key.### Introduction![Isochrone screenshot](./img/isochrone-example.png)An isochrone of a location is ''a line connecting points at which a vehicle arrives at the same time'', see Wikipedia.With the same API you can also calculate isodistances, just use the parameter distance_limit instead of time_limit`.### Use CasesSome possible areas in which this API may be useful to you:- real estate analysis- realtors- vehicle scheduling- geomarketing- reach of electric vehicles- transport planning- logistics (distribution and retail network planning)### API Clients and ExamplesSee the [clients](#section/API-Clients) section in the main documentation, and [live examples](https://graphhopper.com/api/1/examples/#isochrone).
post   ### ExampleYou get an example response for a GPX via:```curl -XPOST -H "Content-Type: application/gpx+xml" "https://graphhopper.com/api/1/match?vehicle=car&key=[YOUR_KEY]" --data @/path/to/some.gpx```A minimal working GPX file looks like```gpx<gpx> <trk>  <trkseg>   <trkpt lat="51.343657" lon="12.360708"></trkpt>   <trkpt lat="51.343796" lon="12.361337"></trkpt>   <trkpt lat="51.342784" lon="12.361882"></trkpt>  </trkseg> </trk></gpx>```### Introduction![Map Matching screenshot](./img/map-matching-example.gif)The Map Matching API is part of the GraphHopper Directions API and with this API you can snap measured GPS points typically as GPX files to a digitalroad network to e.g. clean data or attach certain data like elevation or turn instructions to it. Read more at Wikipedia.In the example screenshot above and demo you see the Map Matching API in action where the black line is the GPS track and the green one is matched result.Most of the times, you can simply POST a GPX file, but some of the request parameters of the [Routing API](#tag/Routing-API) apply here, too.### API Clients and ExamplesSee the [clients](#section/API-Clients) section in the main documentation, and [live examples](https://graphhopper.com/api/1/examples/#map-matching).### Limits and CountsThe cost for one request depends on the number of GPS location and is documented [here](https://graphhopper.com/api/1/docs/FAQ/).One request should not exceed the Map Matching API location limit depending on the package, see the pricing in our dashboard.
post   With this Matrix Endpoint you submit the points and parameters via URL parameters and is the most convenientas it works out-of-the-box in the browser. If possible you shouldprefer using the [POST Matrix Endpoint](#operation/postMatrix) that avoids problems with many locationsand can also gzip the **request**. (Note, that all endpoints return gzipped responses).
post   The [GET endpoint](#operation/getMatrix) has an URL length limitation, which hurts for many locations per request.In those cases use this POST endpoint with a JSON as input. The only parameter in the URL will be the key.Both request scenarios are identical except that all singular parameter names are named as their plural for a POST request.The effected parameters are: `points`, `from_points`, `to_points`, and `out_arrays`. For the remaining parametersplease refer to the [guide of the GET endpoint](#operation/getMatrix).**Please note that in contrast to GET endpoint the points have to be specified as `[longitude, latitude]` array (in that order, similar to [GeoJson](http://geojson.org/geojson-spec.html#examples))**.For example the query `point=10,11&point=20,22&vehicle=car` will be converted to the following JSON:```json{ "points": [[11,10], [22,20]], "vehicle": "car" }```A complete curl Example:```bashcurl -X POST -H "Content-Type: application/json" "https://graphhopper.com/api/1/matrix?key=[YOUR_KEY]" -d '{"elevation":false,"out_arrays":["weights", "times"],"from_points":[[-0.087891,51.534377],[-0.090637,51.467697],[-0.171833,51.521241],[-0.211487,51.473685]],"to_points":[[-0.087891,51.534377],[-0.090637,51.467697],[-0.171833,51.521241],[-0.211487,51.473685]],"vehicle":"car"}'```
post   Prefer the [synchronous endpoint](#operation/postMatrix) and use this Batch endpoint for long running problems only.The Batch Matrix endpoint allows using matrices with more locations and works asynchronously - similar to the [Batch Route Optimization endpoint](#operation/asyncVRP): * Create a HTTP POST request against `/matrix/calculate` and add the key in the URL: `/matrix/calculate?key=[YOUR_KEY]`. This will give you the `job_id` from the response json like `{ "job_id": "7ac65787-fb99-4e02-a832-2c3010c70097" }` * Poll via HTTP GET requests every 500ms against `/matrix/solution/[job_id]`Here are some full examples via curl:```bash$ curl -X POST -H "Content-Type: application/json" "https://graphhopper.com/api/1/matrix/calculate?key=[YOUR_KEY]" -d '{"points":[[13.29895,52.48696],[13.370876,52.489575],[13.439026,52.511206]]}'{"job_id":"7ac65787-fb99-4e02-a832-2c3010c70097"}```Pick the returned `job_id` and use it in the next GET requests:```bash$ curl -X GET "https://graphhopper.com/api/1/matrix/solution/7ac65787-fb99-4e02-a832-2c3010c70097?key=[YOUR_KEY]"{"status":"waiting"}```When the calculation is finished (`status:finished`) the JSON response will contain the full matrix JSON under `solution`:```bash$ curl -X GET "https://graphhopper.com/api/1/matrix/solution/7ac65787-fb99-4e02-a832-2c3010c70097?key=[YOUR_KEY]"{"solution":{"weights":[[0.0,470.453,945.414],[503.793,0.0,580.871],[970.49,569.511,0.0]],"info":{"copyrights":["GraphHopper","OpenStreetMap contributors"]}},"status":"finished"}```Please note that if an error occured while calculation the JSON will not have a status but contain directly the error message e.g.:```json{"message":"Cannot find from_points: 1"}```And the optional `hints` array.
get   This endpoint returns the solution of a JSON submitted to the Batch Matrix endpoint. You can fetch it with the job_id, you have been sent.
get   The GET request is the most simple one: just specify the parameter in the URL and you are done.Can be tried directly in every browser.
post   Please see the [GET endpoint](#operation/getRoute) for a simpler method on how to get started.If you are familiar with POST requests and JSON then do not hesitate to continue here.Especially when you use many locations you should get familiar with this POST endpoint as the GET endpointhas an URL length limitation. Additionally the request of this POST endpoint can be compressed and can slightlyspeed up the request.To do a request you send JSON data. Both request scenarios GET and POST are identical except that all singular parameter names are named as their plural for a POST request.The effected parameters are: `points`, `point_hints` and `snap_preventions`.**Please note that in opposite to the GET endpoint, points are specified in the order of `longitude, latitude`**.For example `point=10,11&point=20,22` will be converted to the `points` array (plural):```json{ "points": [[11,10], [22,20]] }```Note again that also the order changes from `[latitude,longitude]` to `[longitude,latitude]`similar to [GeoJson](http://geojson.org/geojson-spec.html#examples).Example:```bashcurl -X POST -H "Content-Type: application/json" "https://graphhopper.com/api/1/route?key=[YOUR_KEY]" -d '{"elevation":false,"points":[[-0.087891,51.534377],[-0.090637,51.467697]],"vehicle":"car"}'```
get   Use this to find out details about the supported vehicle profiles and features, or if you just need to ping the server.
post   To get started with the Route Optimization API, please read the [introduction](#tag/Route-Optimization-API).To solve a new vehicle routing problem, make a HTTP POST to this URL```https://graphhopper.com/api/1/vrp?key=<your_key>```It returns the solution to this problem in the JSON response.Please note that this URL is very well suited to solve minor problems.Larger vehicle routing problems, which take longer than 10 seconds to solve, cannot be solved.To solve them, please use the [batch mode URL](#operation/asyncVRP) instead.
post   To solve a vehicle routing problem, perform the following steps:1.) Make a HTTP POST to this URL```https://graphhopper.com/api/1/vrp/optimize?key=<your_key>```It returns a job id (job_id).2.) Take the job id and fetch the solution for the vehicle routing problem from this URL:```https://graphhopper.com/api/1/vrp/solution/<job_id>?key=<your_key>```We recommend to query the solution every 500ms until it returns 'status=finished'.**Note**: Since the workflow is a bit more cumbersome and since you lose some time in fetching the solution, you should always preferthe [synchronous endpoint](#operation/solveVRP). You should use the batch mode only for long running problems.
get   Take the job id and fetch the solution for the vehicle routing problem from this URL:```https://graphhopper.com/api/1/vrp/solution/<job_id>?key=<your_key>```You get the job id by sending a vehicle routing problem to the [batch mode URL](#operation/asyncVRP).
post   Record a subscription state between multiple HubSpot contacts and a marketing event, using HubSpot contact ids.
post   Record a subscription state between multiple HubSpot contacts and a marketing event, using contact email addresses. If contact is not present it will be automatically created. If you set params
post   Lock planning level against modification. This is an Enterprise feature.
get   Get all planning levels.
post   Create new user for entity/organization. This can be done by entity administrator.
put   Update user.
get   Get all users
delete   Delete user
get   To support maximum operation and integration speed, this endpoint only returns the calculated forecast.
post   Forecast utilizing Facebookm Prophet, UBER Orbit, amongst other advanced machine learning models. Please be mindful of enhanced execution times (~2s per timeseries).
post   History and forecast utilizing Facebookm Prophet, UBER Orbit, amongst other advanced machine learning models. Please be mindful of enhanced execution times (~2s per timeseries).
post   Forecast from file allows for quick analysis via Microsoft Excel and CSV file format. Please check documentation link for help.
post   Calculate forecast bny timeseries and sum results up to establish forecast for top level timeseries.
post   Calculate forecast based on sum of of lower level timeseries and distribute forecast down based on ratios. Great feature for planning levels with dynamic timeseries.
post   Response provides full forecast result details, including error, trend seasonality and outlier. Great for advanced analysis.
post   Reponse provides history and forecast per timeseries. Great for visualizing results.
post   Use the optimal parameter sets created by iCUE to set the method parameters of the internal planning system.
post   Rerun previously uploaded planning level.
get   Get result for long running forecast job
get   Get status for long running forecast job
get   Get entity global hyperparameters.
post   Set entity global hyperparameters. Hyperparameters can be overwritten by user and planning level (add to JSON body).
post   Calculate Amazon Inventory Performance Index (IPI)
post   Carrying Cost
post   Calculate economic order quantity
post   Calculate fill rate
post   Calculate financial impact of forecast accuracy
post   Inventroy Turn-over
post   Calculate lead time demand
post   Calculate minimum order quantity
post   Calculate optimal service level
post   Re-order Point
post   Safety Stock
post   Calculate service level
post   Calculate inventory turns
post   Supports the creation of artificial startup history for new products, based on a flexible mapping of old to new. This is an Enterprise feature.
post   Supports the creation of artificial startup history for new products, based on a flexible mapping of old to new. This is an Enterprise feature.
post   Identify outliers (single and repetitive spikes, seasonality, masked outliers, trend and level jumps, amongst other topics) and use for cleansing of the history stream prior to forecast claculation. Depending on math model used, this approach often improves results dramatically, as it removes disturbances.
post   Calculate and retrieve results of ABC (pareto analysis) and xyz (Coefficient of variation) per timeseries and planning level. This analysis is a powerful means to estbalish a proper planning cadence, best accuracy messures and optimal hyperparameters for the organization. It provides a balanced and actionable overview of the entire product portfolio.
post   Calculate and retrieve results of ABC (pareto analysis) per timeseries and planning level.
post   Planning level rewind to calculate and measure performance potential (internal versus iCUE).
post   Calculate and retrieve results of xyz (Coefficient of variation) per timeseries and planning level.
post   Bundle pricing
get   SKU rationalization report
get   Month over month performance per planning level
get   Get list of plannign levels by organization
get   Get list of plannign levels by user
get   Get usage statistics per user
get   Multiple studies in tabular form
get   Returns compounds found
get   Returns similar compounds
get   Returns compounds with the specified substructure
get   Returns endpoint summary
get   Returns a list of substances, according to the search criteria
get   Returns substance representation
get   Returns substance composition
get   Returns substance composition
get   Returns substance study representation
get   Study summary
get   Get recent media from a geography subscription that you created.**Note:** You can only access Geographies that were explicitly created by your OAuth client. Check theGeography Subscriptions section of the [real-time updates page](https://instagram.com/developer/realtime/).When you create a subscription to some geography that you define, you will be returned a unique `geo-id` thatcan be used in this query. To backfill photos from the location covered by this geography, use the[media search endpoint](https://instagram.com/developer/endpoints/media/).**Warning:** [Deprecated](http://instagram.com/developer/changelog/) for Apps created **on or after** Nov 17, 2015
get   Search for a location by geographic coordinate.
get   Get information about a location.
get   Get a list of recent media objects from a given location.
get   Get a list of what media is most popular at the moment. Can return mix of `image` and `video` types.**Warning:** [Deprecated](http://instagram.com/developer/changelog/) for Apps created **on or after** Nov 17, 2015
get   Search for media in a given area. The default time span is set to 5 days. The time span must not exceed 7 days.Defaults time stamps cover the last 5 days. Can return mix of `image` and `video` types.
get   This endpoint returns the same response as `GET /media/{media-id}`.A media object's shortcode can be found in its shortlink URL. An example shortlink is`http://instagram.com/p/D/`, its corresponding shortcode is `D`.
get   Get information about a media object. The returned type key will allow you to differentiate between image andvideo media.**Note:** if you authenticate with an OAuth Token, you will receive the user_has_liked key which quickly tellsyou whether the current user has liked this media item.
get   Get a list of recent comments on a media object.
post   Create a comment on a media object with the following rules:  * The total length of the comment cannot exceed 300 characters.  * The comment cannot contain more than 4 hashtags.  * The comment cannot contain more than 1 URL.  * The comment cannot consist of all capital letters.
delete   Remove a comment either on the authenticated user's media object or authored by the authenticated user.
delete   Remove a like on this media by the currently authenticated user.
get   Get a list of users who have liked this media.
post   Set a like on this media by the currently authenticated user.
get   Search for tags by name.
get   Get information about a tag object.
get   Get a list of recently tagged media. Use the `max_tag_id` and `min_tag_id` parameters in the paginationresponse to paginate through these objects.
get   Search for a user by name.
get   See the authenticated user's feed.**Warning:** [Deprecated](http://instagram.com/developer/changelog/) for Apps created **on or after** Nov 17, 2015
get   See the list of media liked by the authenticated user. Private media is returned as long as the authenticateduser has permission to view that media. Liked media lists are only available for the currently authenticateduser.
get   List the users who have requested this user's permission to follow.
get   Get basic information about a user. To get information about the owner of the access token, you can use**self** instead of the `user-id`.Security scope `public_content` is required to read information about other users.
get   Get the list of users this user is followed by. To get users followed by the owner of the access token, youcan use **self** instead of the `user-id`.
get   Get the list of users this user follows. To get follows of the owner of the access token, you can use **self**instead of the `user-id`.
get   Get the most recent media published by a user. To get the most recent media published by the owner of theaccess token, you can use **self** instead of the `user-id`.Security scope `public_content` is required to read information about other users.
get   Get information about a relationship to another user.
post   Modify the relationship between the current user and the target user.
get   Returns the name and a list of books by the author.
get   This returns a list of authors whos name matches the given query
get   Returns the book details
get   This returns a list of books that match the query
get   Returns details and a list of books by the publisher.
get   This returns a list of publishers that match the given query
get   Uses a free query string compatible with ElasticSearch 6 to search in any of the ISBNDB's databases
get   Returns a status object about the ISBNDB database.
get   Returns details and a list of books with subject.
get   This returns a list of subjects that match the given query
post   Endpoint used to create or update an account.
delete   Endpoint used to remove a user from an account.
post   Endpoint used to add a user to an account.
post   Endpoint used to push an event for a user or an account.
post   Endpoint used to link web activity to a user.
get   Endpoint used to get a snippet for a website.
post   Endpoint to create or update a user.
get   Endpoint used to test the validity and some basic information about a specific API Key.
get   Lists all global course design templates. Only api callers that have full access can call this method.
get   Returns information about the organization unit with the specified external id.
get   Gets a participation by external id.
get   Gets an Organization Unit by external id
get   Gets a user by external id.
get   Returns a list of Global User Groups. Global User Groups are set up for the realm, and will generate groups that can be used on the client level.
get   Returns a list of all members in User Groups that are based on the Global Group with this groupid.
get   The orgunits endpoint returns information about the available organization units (orgunits).The response includes the display name, internal and external id and client number.
post   Adds an Organization Unit
get   Returns information about the specified organization unit.The response includes the display name, internal and external id and client number.
put   Adds an Organization Unit
get   Returns the available projects for the organization unit
post   Creates a new project
delete   Deletes the project. The project can only be deleted if the project do not contain any participants.
get   Returns project information
put   Updates information about a project. Values are only updated if the fields are specified in the input
get   Returns project participants
post   Add a user to the project. Participant information is created for the user. In the body object, only one of either email or userid must be specified. The participant needs to be activated before it the user can access it.
delete   Deletes a participant. The user itself will still remain but any state related to the project will be deleted.It might not be possible due to constraints from the products in the project to delete the participant. Howeverthis can only be determined at the time of the delete. If a delete fails the participant will have their inErrorflag set.
post   Activates a participant so that it can be used
post   Returns a single sign on link for the participant. The link is only usable once and should be used directly. The link expires after a few minutes.This operation requires the *login link* permission.
get   Returns the project team members. A team member is a ....
get   Returns a list of User Groups for the org unit.
post   Create a User Group.
get   Returns single User Group.
get   Returns a list of all members in User Groups that are based on the Global Group with this groupid.
post   Adds a user to user group.
delete   Removes a user from a user group.
get   Lists all users. Only api callers that have full access can call this method.
post   Adds a user. No two users can have the same email address. Email is saved WITH case but compared regardless of case. Email can be changed for a user assuming it doesn't cause a conflict.
get   Returns information about a user
put   Updates a user. All values that have a key defined in the input will be set. So if a value should not be updated omit it totally from the input, otherwise it will be unset.
get   Returns a thumbnail picture of the user. This can either be a selected picture or an auto generated image. This method doesn't require a full sign in. The api key is sufficient.The image is square and is likely, but not necessary, to be in 128x128 PNG format. However the format will always be either PNG, JPEG or GIF.
get   Returns information about the projects the user is a participant in. Only the projects that the current token have access to will be listed.
get   Get the version information of this API.
get   Get a summary of the analysis results for a specific analysis identifier.To find the analysis identifier for a commit, use the `/analyses/{project-id}/commits/{commit-id}` endpoint. For more information, see [Get analysis summary for a specific commit](https://lgtm.com/help/lgtm/api/api-v1#opIdgetAnalysisForCommit).This endpoint reports the commit analyzed and a summary of the results for each language. Alternatively, you can use this identifier to download full details  of all the alerts found by the analysis. For more information, see [Get detailed alert information](https://lgtm.com/help/lgtm/api/api-v1#opIdgetAlerts).
get   Download all the alerts found by an analysis.Use the `Accept:` request header to specify the output media type as either CSV or [SARIF](https://lgtm.com/help/lgtm/sarif-results-file): - `application/sarif+json`: Alerts in SARIF format. If no version is specified the latest supported SARIF version is used.- `application/json`: Alerts in SARIF format (*deprecated*).   If no version is specified, [SARIF 2.0.0](http://docs.oasis-open.org/sarif/sarif/v2.0/sarif-v2.0.html)   is used for backwards compatibility.- `text/csv`: Alerts in CSV format. The `text/csv` media type has two optional parameters:   - `charset`: determines the character encoding of the text, by default UTF-8.   - `header`: determines whether a header row with column names is `present` or `absent`.      The default value for this parameter is `present`.      For example, an Accept header with value `text/csv; header=absent`       would result in CSV output without a header row.    To find the analysis identifier for a commit, use the `/analyses/{project-id}/commits/{commit-id}`  endpoint. For more information, see [Get analysis summary for a specific commit](https://lgtm.com/help/lgtm/api/api-v1#opIdgetAnalysisForCommit).
post   Trigger the analysis of a specific commit to a project. If a previous attempt to analyze that commit failed, this triggers a fresh analysis.  This is supported for all LGTM projects, regardless of repository type or host. The commit must be available in the main repository, but can be on a branch that isn't tracked by LGTM. For both LGTM.com and LGTM Enterprise, you must include an access token with the `analyses:write` scope.When you request the analysis of a commit, the API returns:- `operation-id`: used to track the status of the task using the `/operations` endpoint. For more information, see [Get operation status](https://lgtm.com/help/lgtm/api/api-v1#opIdgetOperation).- `status`: initially pending.- `task-result`: containing information about the progress and results of the analysis.
get   Get a summary of the analysis results for a specific commit, or the latest commit, to a project. (For projects configured for sparse or upload analysis, only `latest` is supported.) This endpoint reports a summary of results for each language, and also the analysis identifier. You can use the analysis identifier to download full details of all the alerts  found by the analysis. For more information, see [Get detailed alert information](https://lgtm.com/help/lgtm/api/api-v1#opIdgetAlerts).
post   Trigger the code review of a patch. This is available for projects with Git repositories.Your request must include:  * Identifier for the base commit  * Patch generated using `git diff --binary` (see [git diff](https://git-scm.com/docs/git-diff))  * Header `Content-Type: application/octet-stream`  * For both LGTM.com and LGTM Enterprise, an access token with the `codereviews:write` scopeNote that if you make a request using Curl, you'll also need to add `--data-binary` to the request to ensure that the patch you supply in the body is sent with newlines unchanged.You can track the progress of the review using the task result URL returned on creation of the task, or by calling the `/operations` endpoint with the operations identifier returned by the request. For more information, see [Get operation status](https://lgtm.com/help/lgtm/api/api-v1#opIdgetOperation). Alternatively, if you supply a callback URL you'll get a post-back automatically on completion of the review.When the review is complete, you can access the results using the task result URL.
get   Get the results of a code review using the review identifier for the task.When you request a code review, the response includes a task result URL of the form: `/codereviews/{review-id}`.This endpoint reports the results of a complete code review, or the status of a review  that's still in progress.
get   Fetch the alert information for an issue in [SARIF](https://lgtm.com/help/lgtm/sarif-results-file) format.
get   Get the specification of this API in [OpenAPI](https://github.com/OAI/OpenAPI-Specification) format. This endpoint does not require an access token. This makes it easier for you to use the specification with third-party tools.
get   Track progress of a long-running operation using the operations identifier returned when you  created the operation. For example, by triggering the analysis of a commit, or the code review of a patch. For both LGTM.com and LGTM Enterprise, you must include an access token with the `operations:read` scope.
get   List all the projects the current user has authorization to view. A maximum of 100 projects are returned in each response. When further results are available, the response includes the URL you need to request the next page of results.Use the optional parameter, `limit`, to change the number of results reported in each response (range of 1&mdash;100). If you supply an invalid value for this  parameter, the default value of 100 is used.When more than one page of results is available, each response includes a `nextPageUrl` response parameter. You can use this URL to request the next page of results. The `nextPageUrl` includes an automatically generated `start` parameter, which specifies the projects to return in the next page of results.
post   LGTM administrators can add a new project to LGTM by providing a repository URL. By default, LGTM tries to build and analyze the project in the same way as for projects added through the user interface. If at least one language is successfully analyzed, and the repository doesn't already exist on LGTM, a new project is created. If the project already exists but your API call triggers a successful analysis  of additional languages, LGTM adds those languages to the project.You can configure how LGTM processes the project using query parameters to:  * Specify the languages to analyze.  * Create a new project in [sparse mode](https://help.semmle.com/lgtm-enterprise/user/help/analysis-faqs.html#what-is-sparse-analysis).  * Create a new project in [upload mode](https://help.semmle.com/lgtm-enterprise/user/help/analysis-faqs.html#what-is-upload-analysis) to analyze externally-generated databases. Each database represents a snapshot of the codebase.   Use this option when you want to upload databases that were generated by the CodeQL CLI (or the QL command-line tools).  The version of the command line used to generate the database  must be the same version as LGTM Enterprise. With any of these options, you can also include an `lgtm.yml` in the body of the request to [customize extraction](https://lgtm.com/help/lgtm/customizing-code-extraction).
delete   Delete a project with a particular numeric project identifier.In addition to access to the project, administrative access to LGTM or the LGTM Enterprise instance is required to delete projects.
get   Get the latest summary for a specific project using the numeric project identifier.To find the LGTM identifier for a project, list all projects using the `/projects`  endpoint and look up the project by name. Alternatively, use the `/projects/{provider}/{org}/{name}` endpoint. If you have administration access, the project identifier is also displayed in  the administration page for the project.
get   Get the latest configuration for a specific project using the numeric project identifier.
put   Set the administrator configuration for a specific project using the numeric project identifier.
get   Get the latest summary for a specific project using the project's URL identifier `{provider}/{org}/{name}`.To find the URL identifier for a project, view the project overview page in LGTM. The URL identifier follows after `/projects`. For example, for a project with the URL `https://lgtm.example.com/projects/g/apache/commons-io` the URL identifier is `g/apache/commons-io`. In the example, `g` represents the `provider` (repository host), `apache` is the `organization` and `commons-io` is the `name` of the repository.
post   Submit a query to run on one or more projects on LGTM. The query is included in the body of the request.
get   Get the status of a query job using the query job identifier for the task.When you create a query job, the response includes a task result URL of the form: `/queryjobs/{queryjob-id}`.
get   This endpoint provides a summary of the results generated by completed query runs for each  project specified in the the POST /queryjobs endpoint.  For completed query jobs, the summary includes:  * The number of results for successful query runs.  * Error information for failed query runs.No information is included in the response for any project for which the query  run is still in progress.
get   Fetch the results for a specific project. The endpoint succeeds only if the query was successful,  and returns a `404` error otherwise.  By default, the endpoint provides only results that are within the source tree. To obtain all results, specify the `nofilter` parameter.
delete   Aborts the specified upload session and deletes any uploaded parts. After the session is aborted it cannot be restarted.If any part uploads are in progress when the session is aborted, their data may not be deleted. To ensure that uploaded parts are deleted correctly, you should only abort an upload session after all part uploads have completed.
post   Completes the database upload by closing the upload session, upgrading the database if appropriate, and scheduling analysis of that snapshot of the codebase.You can view the analysis progress and access the results using the `task-result-url`.
put   Upload a database representing a snapshot of a codebase.  The database is sent in one or more parts. Each part is sent in the request body. Use the [`POST /snapshots/{project-id}/{language}`](https://lgtm.com/help/lgtm/api/api-v1#opIdinitSnapshotUpload) endpoint  to start an upload session before uploading a database part. Database parts must have been generated and prepared for upload using the CodeQL CLI or the QL command-line tools. For further information on exporting externally-built databases,  see [Preparing snapshots to upload to LGTM](https://help.semmle.com/wiki/display/SD/Preparing+snapshots+to+upload+to+LGTM).Split large databases into multiple parts. Upload the parts by making a separate request for each part.  Don't upload the next part until you've successfully uploaded the previous part.If the upload fails you should retry it with the same data.
get   Download a CodeQL database from LGTM, representing a snapshot of the codebase, to run queries in your IDE.This endpoint works for projects that have been successfully analyzed for the language specified in the request.  A successful request redirects you to a URL for downloading a database that represents the code snapshot, as specified in the `Location:` header in the response. Therefore, your HTTP client should be configured to follow redirects. For example, if you are using `curl`, you can add the`-L` flag to the command.The database is downloaded as a zip file that can be imported into an IDE equipped with a  CodeQL extension. The extension must be up to date to analyze databases downloaded from LGTM. For more information on running queries locally in your IDE, see [Runnning queries in your IDE](https://lgtm.com/help/lgtm/running-queries-ide).
post   Start a session to upload an externally-built database (which represents a snapshot of a codebase) to a project on LGTM. This endpoint works for projects that are already on LGTM, and the selected language of  the database must already be configured. The project must be configured with 'upload' analysis mode. You can upload a "bundled" CodeQL database or a database exported by  the QL command-line tools (`odasa`).If your database was generated using a version of the  command line that is older than LGTM,  LGTM will try to upgrade and analyze it when the upload is complete. You can include cached predicates in the upload, but they are ignored as the cache is  repopulated after the database has been upgraded and analyzed. However, if you want to include results with your database, make sure the database is  compatible before you start the upload session.  Incompatible databases with results won't be upgraded and therefore cannot be uploaded.  For further information on externally-built databases,  see [Preparing snapshots to upload to LGTM using the QL command-line tools](https://help.semmle.com/wiki/display/SD/Preparing+snapshots+to+upload+to+LGTM).    When the upload session has been successfully started, upload the database to the  upload URL returned in the response. The database can be uploaded to the upload URL in parts using  the [`PUT /snapshots/uploads/{session-id}`](https://lgtm.com/help/lgtm/api/api-v1#opIduploadPart) endpoint. After uploading all the parts you must call  the [`POST /snapshots/uploads/{session-id}`](https://lgtm.com/help/lgtm/api/api-v1#opIdcompleteUpload) endpoint to complete the upload session.
get   Return an indication of whether the application is working as expected (up) or needs  attention (down). \> The `description` and `details` fields are reported only if the request includes an access token for a user account that has administration rights for this LGTM server.
get   LGTM administrators can use this endpoint to list the usage metrics that are available to download.
get   LGTM administrators can download usage data using this endpoint. The response includes up to 1000 values for the specified metric and reports the date-time that each value was calculated. There is normally one value per day.
get   Visits the URL and checks if there are mobile apps on them and returns the found ones.Will by default return the app identifiers and not the full URL to the apps. To return URLs instead set the parameter "return_urls" to true.The URLs can also be created manually like this:| Property | URL                                                || -------- | -------------------------------------------------- || android  | https://play.google.com/store/apps/details?id={ID} || ios      | https://itunes.apple.com/us/app/app-name/id{ID}    |Properties only get set when a value for it has been found. That means that if no app has been found only the property "url" will be set.
get   Visits the URL with a full browser and extracts the data. This request costs 5 credits.
get   Visits the URL with full browser and creates a screenshot. This request costs 5 credits.
get   Visits the URL and extracts the data.
get   Visits the URL and extracts the data.
get   Visits the URL and extracts tabular data.
get   Visits the URL and checks if there are Geo Coordinates on them and returns the found ones.Properties only get set when a value for both latitude and longitude have been found. That means that if no geo coordinates have been found only the property "url" will be set.
get   Visits the URL and checks if there are any social media accounts and returns the found ones.Will by default return the account identifiers and not the full URL to the profiles. To return URLs instead set the parameter "return_urls" to true.The URLs can also be created manually like this:| Property        | URL                                    || --------------- | -------------------------------------- || facebookPage    | https://facebook.com/{ID}              || githubUser      | https://github.com/{ID}                || googlePlus      | https://plus.google.com/+{ID}          || instagram       | https://instagram.com/{ID}             || linkedInCompany | https://linkedin.com/company/{ID}      || pinterest       | https://pinterest.com/{ID}             || twitter         | https://twitter.com/{ID}               || youTubeUser     | https://youtube.com/user/{ID}          |Properties only get set when a value for it has been found. That means that if no social media account has been found only the property "url" will be set.
get   Get all api keys
get   Get all global auth. module configs
post   Create one global auth. module config
delete   Delete one global auth. module config
get   Get one global auth. module configs
put   Update one global auth. module config
put   Update one global auth. module config
get   Get all certificates
post   Create one certificate
delete   Delete one certificate by id
get   Get one certificate by id
put   Update one certificate by id
put   Update one certificate by id
get   Get all validation authoritiess
post   Create one validation authorities
delete   Delete one validation authorities by id
get   Get one validation authorities by id
put   Update one validation authorities by id
put   Update one validation authorities by id
get   Get all data exporter configs
post   Create a new data exporter config
delete   Delete a data exporter config
put   Update a data exporter configs with a diff
post   Create a new data exporter configs
put   Update a data exporter configs
get   Get all data exporter configs
delete   Delete a data exporter config
get   Get a data exporter config
put   Update a data exporter config with a diff
put   Update a data exporter config
get   Get the full configuration of Otoroshi
put   Update the global configuration with a diff
put   Update the global configuration
get   Get all service groups
post   Create a new service group
get   Get all api keys for the group of a service
post   Create a new api key for a group
delete   Delete an api key for a specified service group
get   Get an api key for a specified service group
put   Update an api key for a specified service descriptor with a diff
put   Update an api key for a specified service group
delete   Reset the quota state of an api key
get   Get the quota state of an api key
delete   Delete a service group
get   Get a service group
put   Update a service group with a diff
put   Update a service group
get   Get all services descriptor for a group
post   Import the full state of Otoroshi as a file
get   Get global otoroshi stats
get   Get live feed of global otoroshi stats (global) or for a service {id}
get   Export the full state of Otoroshi
post   Import the full state of Otoroshi
get   Get all scripts
post   Create a new script
post   Compile a script
delete   Delete a script
get   Get a script
put   Update a script with a diff
put   Update a script
get   Get all services
post   Create a new service descriptor
delete   Delete a service descriptor
get   Get a service descriptor
put   Update a service descriptor with a diff
put   Update a service descriptor
get   Get all api keys for the group of a service
post
delete   Delete an api key for a specified service descriptor
get   Get an api key for a specified service descriptor
put   Update an api key for a specified service descriptor with a diff
put   Update an api key for a specified service descriptor
get   Get the group of an api key
delete   Reset the quota state of an api key
get   Get the quota state of an api key
delete   Delete a service descriptor target
get   Get a service descriptor targets
put   Update a service descriptor targets
post   Add a target to a service descriptor
delete   Delete a service descriptor error template
get   Get a service descriptor error template
post   Update a service descriptor targets
put   Update an error template to a service descriptor
post   Start the Snow Monkey
post   Stop the Snow Monkey
get   Get current Snow Monkey config
put   Update current Snow Monkey config
put   Update current Snow Monkey config
delete   Reset Snow Monkey Outages for the day
get   Get all current Snow Monkey ourages
get   Get all global JWT verifiers
post   Create one global JWT verifiers
delete   Delete one global JWT verifiers
get   Get one global JWT verifiers
put   Update one global JWT verifiers
put   Update one global JWT verifiers
get   Import the full state of Otoroshi as a file
get   Get all environments provided by the current Otoroshi instance
get   Get all services for an environment provided by the current Otoroshi instance
get   Get a template of an Otoroshi Api Key. The generated entity is not persisted
get   Get a template of an Otoroshi service group. The generated entity is not persisted
get   Get a template of an Otoroshi service descriptor. The generated entity is not persisted
post   Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account's activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.
post   Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.
post   Returns a list of your exports.
post   Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.
post   Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive containing a single file named whitelist.csv that includes the following fields: email, detail, created_at.
post   Add an inbound domain to your account
post   Add a new mailbox route to an inbound domain
post   Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call
post   Delete an inbound domain from the account. All mail will stop routing for this domain immediately.
post   Delete an existing inbound mailbox route
post   List the domains that have been configured for inbound delivery
post   List the mailbox routes defined for an inbound domain
post   Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP
post   Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.
post   Cancels the warmup process for a dedicated IP.
post   Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.
post   Creates a pool and returns it. If a pool already exists with this name, no action will be performed.
post   Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.
post   Deletes a dedicated IP. This is permanent and cannot be undone.
post   Retrieves information about a single dedicated ip.
post   Lists your dedicated IP pools.
post   Lists your dedicated IPs.
post   Describes a single dedicated IP pool.
post   Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.
post   Configures the custom DNS name for a dedicated IP.
post   Moves a dedicated IP to a different pool.
post   Begins the warmup process for a dedicated IP. During the warmup process, Mandrill will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.
post   Cancels a scheduled email.
post   Get the full content of a recently sent message
post   Get the information for a single recently sent message
post   Queries your scheduled emails by sender or recipient, or both.
post   Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces
post   Reschedules a scheduled email.
post   Search the content of recently sent messages and return the aggregated hourly stats for matching messages
post   Search the content of recently sent messages and optionally narrow by date range, tags and senders. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying.
post   Take a raw MIME document for a message, and send it exactly as if it were sent through Mandrill's SMTP servers
post   Send a new transactional message through Mandrill using a template
post   Send a new transactional message through Mandrill
post   Add a new custom metadata field to be indexed for the account.
post   Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
post   Get the list of custom metadata fields indexed for the account.
post   Update an existing custom metadata field.
post   Adds an email to your email rejection blacklist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your blacklist. Attempting to blacklist an address that has been whitelisted will have no effect.
post   Deletes an email rejection. There is no limit to how many rejections you can remove from your blacklist, but keep in mind that each deletion has an affect on your reputation.
post   Retrieves your email rejection blacklist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.
post   Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.
post   Checks the SPF and DKIM settings for a domain. If you haven't already added this domain to your account, it will be added automatically.
post   Returns the sender domains that have been added to this account.
post   Return more detailed information about a single sender, including aggregates of recent stats
post   Return the senders that have tried to use this account.
post   Return the recent history (hourly stats for the last 30 days) for a sender
post   Sends a verification email in order to verify ownership of a domain. Domain verification is an optional step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.
post   Add a new subaccount
post   Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.
post   Given the ID of an existing subaccount, return the data about it
post   Get the list of subaccounts defined for the account, optionally filtered by a prefix
post   Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.
post   Resume a paused subaccount's sending
post   Update an existing subaccount
post   Return the recent history (hourly stats for the last 30 days) for all tags
post   Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully.
post   Return more detailed information about a single tag, including aggregates of recent stats
post   Return all of the user-defined tag information
post   Return the recent history (hourly stats for the last 30 days) for a tag
post   Add a new template
post   Delete a template
post   Get the information for an existing template
post   Return a list of all the templates available to this user
post   Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft.
post   Inject content and optionally merge fields into a template, returning the HTML that results
post   Return the recent history (hourly stats for the last 30 days) for a template
post   Update the code for an existing template. If null is provided for any fields, the values will remain unchanged.
post   Add a tracking domain to your account
post   Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call
post   Get the 100 most clicked URLs
post   Return the 100 most clicked URLs that match the search query given
post   Return the recent history (hourly stats for the last 30 days) for a url
post   Get the list of tracking domains set up for this account
post   Return the information about the API-connected user
post   Validate an API key and respond to a ping
post   Validate an API key and respond to a ping (anal JSON parser version)
post   Return the senders that have tried to use this account, both verified and unverified
post   Add a new webhook
post   Delete an existing webhook
post   Given the ID of an existing webhook, return the data about it
post   Get the list of all webhooks defined on the account
post   Update an existing webhook
post   Adds an email to your email rejection whitelist. If the address is currently on your blacklist, that blacklist entry will be removed automatically.
post   Removes an email address from the whitelist.
post   Retrieves your email rejection whitelist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results.
get   Lists all global course design templates. Only api callers that have full access can call this method.
get   Returns information about the organization unit with the specified external id.
get   Gets a participation by external id.
get   Gets an Organization Unit by external id
get   Gets a user by external id.
get   Returns a list of Global User Groups. Global User Groups are set up for the realm, and will generate groups that can be used on the client level.
get   Returns a list of all members in User Groups that are based on the Global Group with this groupid.
get   The orgunits endpoint returns information about the available organization units (orgunits).The response includes the display name, internal and external id and client number.
post   Adds an Organization Unit
get   Returns information about the specified organization unit.The response includes the display name, internal and external id and client number.
put   Adds an Organization Unit
get   Returns the available projects for the organization unit
post   Creates a new project
delete   Deletes the project. The project can only be deleted if the project do not contain any participants.
get   Returns project information
put   Updates information about a project. Values are only updated if the fields are specified in the input
get   Returns project participants
post   Add a user to the project. Participant information is created for the user. In the body object, only one of either email or userid must be specified. The participant needs to be activated before it the user can access it.
delete   Deletes a participant. The user itself will still remain but any state related to the project will be deleted.It might not be possible due to constraints from the products in the project to delete the participant. Howeverthis can only be determined at the time of the delete. If a delete fails the participant will have their inErrorflag set.
post   Activates a participant so that it can be used
post   Returns a single sign on link for the participant. The link is only usable once and should be used directly. The link expires after a few minutes.This operation requires the *login link* permission.
get   Returns the project team members. A team member is a ....
get   Returns a list of User Groups for the org unit.
post   Create a User Group.
get   Returns single User Group.
get   Returns a list of all members in User Groups that are based on the Global Group with this groupid.
post   Adds a user to user group.
delete   Removes a user from a user group.
get   Lists all users. Only api callers that have full access can call this method.
post   Adds a user. No two users can have the same email address. Email is saved WITH case but compared regardless of case. Email can be changed for a user assuming it doesn't cause a conflict.
get   Returns information about a user
put   Updates a user. All values that have a key defined in the input will be set. So if a value should not be updated omit it totally from the input, otherwise it will be unset.
get   Returns a thumbnail picture of the user. This can either be a selected picture or an auto generated image. This method doesn't require a full sign in. The api key is sufficient.The image is square and is likely, but not necessary, to be in 128x128 PNG format. However the format will always be either PNG, JPEG or GIF.
get   Returns information about the projects the user is a participant in. Only the projects that the current token have access to will be listed.
get   Get the version information of this API.
get   Get a summary of the analysis results for a specific analysis identifier.To find the analysis identifier for a commit, use the `/analyses/{project-id}/commits/{commit-id}` endpoint. For more information, see [Get analysis summary for a specific commit](https://lgtm.com/help/lgtm/api/api-v1#opIdgetAnalysisForCommit).This endpoint reports the commit analyzed and a summary of the results for each language. Alternatively, you can use this identifier to download full details  of all the alerts found by the analysis. For more information, see [Get detailed alert information](https://lgtm.com/help/lgtm/api/api-v1#opIdgetAlerts).
post   Download all the alerts found by an analysis.Use the `Accept:` request header to specify the output media type as either CSV or [SARIF](https://lgtm.com/help/lgtm/sarif-results-file): - `application/sarif+json`: Alerts in SARIF format. If no version is specified the latest supported SARIF version is used.- `application/json`: Alerts in SARIF format (*deprecated*).   If no version is specified, [SARIF 2.0.0](http://docs.oasis-open.org/sarif/sarif/v2.0/sarif-v2.0.html)   is used for backwards compatibility.- `text/csv`: Alerts in CSV format. The `text/csv` media type has two optional parameters:   - `charset`: determines the character encoding of the text, by default UTF-8.   - `header`: determines whether a header row with column names is `present` or `absent`.      The default value for this parameter is `present`.      For example, an Accept header with value `text/csv; header=absent`       would result in CSV output without a header row.    To find the analysis identifier for a commit, use the `/analyses/{project-id}/commits/{commit-id}`  endpoint. For more information, see [Get analysis summary for a specific commit](https://lgtm.com/help/lgtm/api/api-v1#opIdgetAnalysisForCommit).
post   Trigger the analysis of a specific commit to a project. If a previous attempt to analyze that commit failed, this triggers a fresh analysis.  This is supported for all LGTM projects, regardless of repository type or host. The commit must be available in the main repository, but can be on a branch that isn't tracked by LGTM. For both LGTM.com and LGTM Enterprise, you must include an access token with the `analyses:write` scope.When you request the analysis of a commit, the API returns:- `operation-id`: used to track the status of the task using the `/operations` endpoint. For more information, see [Get operation status](https://lgtm.com/help/lgtm/api/api-v1#opIdgetOperation).- `status`: initially pending.- `task-result`: containing information about the progress and results of the analysis.
get   Get a summary of the analysis results for a specific commit, or the latest commit, to a project. (For projects configured for sparse or upload analysis, only `latest` is supported.) This endpoint reports a summary of results for each language, and also the analysis identifier. You can use the analysis identifier to download full details of all the alerts  found by the analysis. For more information, see [Get detailed alert information](https://lgtm.com/help/lgtm/api/api-v1#opIdgetAlerts).
post   Trigger the code review of a patch. This is available for projects with Git repositories.Your request must include:  * Identifier for the base commit  * Patch generated using `git diff --binary` (see [git diff](https://git-scm.com/docs/git-diff))  * Header `Content-Type: application/octet-stream`  * For both LGTM.com and LGTM Enterprise, an access token with the `codereviews:write` scopeNote that if you make a request using Curl, you'll also need to add `--data-binary` to the request to ensure that the patch you supply in the body is sent with newlines unchanged.You can track the progress of the review using the task result URL returned on creation of the task, or by calling the `/operations` endpoint with the operations identifier returned by the request. For more information, see [Get operation status](https://lgtm.com/help/lgtm/api/api-v1#opIdgetOperation). Alternatively, if you supply a callback URL you'll get a post-back automatically on completion of the review.When the review is complete, you can access the results using the task result URL.
get   Get the results of a code review using the review identifier for the task.When you request a code review, the response includes a task result URL of the form: `/codereviews/{review-id}`.This endpoint reports the results of a complete code review, or the status of a review  that's still in progress.
post   Fetch the alert information for an issue in [SARIF](https://lgtm.com/help/lgtm/sarif-results-file) format.
get   Get the specification of this API in [OpenAPI](https://github.com/OAI/OpenAPI-Specification) format. This endpoint does not require an access token. This makes it easier for you to use the specification with third-party tools.
post   Track progress of a long-running operation using the operations identifier returned when you  created the operation. For example, by triggering the analysis of a commit, or the code review of a patch. For both LGTM.com and LGTM Enterprise, you must include an access token with the `operations:read` scope.
get   List all the projects the current user has authorization to view. A maximum of 100 projects are returned in each response. When further results are available, the response includes the URL you need to request the next page of results.Use the optional parameter, `limit`, to change the number of results reported in each response (range of 1&mdash;100). If you supply an invalid value for this  parameter, the default value of 100 is used.When more than one page of results is available, each response includes a `nextPageUrl` response parameter. You can use this URL to request the next page of results. The `nextPageUrl` includes an automatically generated `start` parameter, which specifies the projects to return in the next page of results.
post   LGTM administrators can add a new project to LGTM by providing a repository URL. By default, LGTM tries to build and analyze the project in the same way as for projects added through the user interface. If at least one language is successfully analyzed, and the repository doesn't already exist on LGTM, a new project is created. If the project already exists but your API call triggers a successful analysis  of additional languages, LGTM adds those languages to the project.You can configure how LGTM processes the project using query parameters to:  * Specify the languages to analyze.  * Create a new project in [sparse mode](https://help.semmle.com/lgtm-enterprise/user/help/analysis-faqs.html#what-is-sparse-analysis).  * Create a new project in [upload mode](https://help.semmle.com/lgtm-enterprise/user/help/analysis-faqs.html#what-is-upload-analysis) to analyze externally-generated databases. Each database represents a snapshot of the codebase.   Use this option when you want to upload databases that were generated by the CodeQL CLI (or the QL command-line tools).  The version of the command line used to generate the database  must be the same version as LGTM Enterprise. With any of these options, you can also include an `lgtm.yml` in the body of the request to [customize extraction](https://lgtm.com/help/lgtm/customizing-code-extraction).
delete   Delete a project with a particular numeric project identifier.In addition to access to the project, administrative access to LGTM or the LGTM Enterprise instance is required to delete projects.
get   Get the latest summary for a specific project using the numeric project identifier.To find the LGTM identifier for a project, list all projects using the `/projects`  endpoint and look up the project by name. Alternatively, use the `/projects/{provider}/{org}/{name}` endpoint. If you have administration access, the project identifier is also displayed in  the administration page for the project.
get   Get the latest configuration for a specific project using the numeric project identifier.
put   Set the administrator configuration for a specific project using the numeric project identifier.
get   Get the latest summary for a specific project using the project's URL identifier `{provider}/{org}/{name}`.To find the URL identifier for a project, view the project overview page in LGTM. The URL identifier follows after `/projects`. For example, for a project with the URL `https://lgtm.example.com/projects/g/apache/commons-io` the URL identifier is `g/apache/commons-io`. In the example, `g` represents the `provider` (repository host), `apache` is the `organization` and `commons-io` is the `name` of the repository.
post   Submit a query to run on one or more projects on LGTM. The query is included in the body of the request.
get   Get the status of a query job using the query job identifier for the task.When you create a query job, the response includes a task result URL of the form: `/queryjobs/{queryjob-id}`.
get   This endpoint provides a summary of the results generated by completed query runs for each  project specified in the the POST /queryjobs endpoint.  For completed query jobs, the summary includes:  * The number of results for successful query runs.  * Error information for failed query runs.No information is included in the response for any project for which the query  run is still in progress.
get   Fetch the results for a specific project. The endpoint succeeds only if the query was successful,  and returns a `404` error otherwise.  By default, the endpoint provides only results that are within the source tree. To obtain all results, specify the `nofilter` parameter.
post   Aborts the specified upload session and deletes any uploaded parts. After the session is aborted it cannot be restarted.If any part uploads are in progress when the session is aborted, their data may not be deleted. To ensure that uploaded parts are deleted correctly, you should only abort an upload session after all part uploads have completed.
post   Completes the database upload by closing the upload session, upgrading the database if appropriate, and scheduling analysis of that snapshot of the codebase.You can view the analysis progress and access the results using the `task-result-url`.
put   Upload a database representing a snapshot of a codebase.  The database is sent in one or more parts. Each part is sent in the request body. Use the [`POST /snapshots/{project-id}/{language}`](https://lgtm.com/help/lgtm/api/api-v1#opIdinitSnapshotUpload) endpoint  to start an upload session before uploading a database part. Database parts must have been generated and prepared for upload using the CodeQL CLI or the QL command-line tools. For further information on exporting externally-built databases,  see [Preparing snapshots to upload to LGTM](https://help.semmle.com/wiki/display/SD/Preparing+snapshots+to+upload+to+LGTM).Split large databases into multiple parts. Upload the parts by making a separate request for each part.  Don't upload the next part until you've successfully uploaded the previous part.If the upload fails you should retry it with the same data.
post   Download a CodeQL database from LGTM, representing a snapshot of the codebase, to run queries in your IDE.This endpoint works for projects that have been successfully analyzed for the language specified in the request.  A successful request redirects you to a URL for downloading a database that represents the code snapshot, as specified in the `Location:` header in the response. Therefore, your HTTP client should be configured to follow redirects. For example, if you are using `curl`, you can add the`-L` flag to the command.The database is downloaded as a zip file that can be imported into an IDE equipped with a  CodeQL extension. The extension must be up to date to analyze databases downloaded from LGTM. For more information on running queries locally in your IDE, see [Runnning queries in your IDE](https://lgtm.com/help/lgtm/running-queries-ide).
post   Start a session to upload an externally-built database (which represents a snapshot of a codebase) to a project on LGTM. This endpoint works for projects that are already on LGTM, and the selected language of  the database must already be configured. The project must be configured with 'upload' analysis mode. You can upload a "bundled" CodeQL database or a database exported by  the QL command-line tools (`odasa`).If your database was generated using a version of the  command line that is older than LGTM,  LGTM will try to upgrade and analyze it when the upload is complete. You can include cached predicates in the upload, but they are ignored as the cache is  repopulated after the database has been upgraded and analyzed. However, if you want to include results with your database, make sure the database is  compatible before you start the upload session.  Incompatible databases with results won't be upgraded and therefore cannot be uploaded.  For further information on externally-built databases,  see [Preparing snapshots to upload to LGTM using the QL command-line tools](https://help.semmle.com/wiki/display/SD/Preparing+snapshots+to+upload+to+LGTM).    When the upload session has been successfully started, upload the database to the  upload URL returned in the response. The database can be uploaded to the upload URL in parts using  the [`PUT /snapshots/uploads/{session-id}`](https://lgtm.com/help/lgtm/api/api-v1#opIduploadPart) endpoint. After uploading all the parts you must call  the [`POST /snapshots/uploads/{session-id}`](https://lgtm.com/help/lgtm/api/api-v1#opIdcompleteUpload) endpoint to complete the upload session.
get   Return an indication of whether the application is working as expected (up) or needs  attention (down). \> The `description` and `details` fields are reported only if the request includes an access token for a user account that has administration rights for this LGTM server.
get   LGTM administrators can use this endpoint to list the usage metrics that are available to download.
post   LGTM administrators can download usage data using this endpoint. The response includes up to 1000 values for the specified metric and reports the date-time that each value was calculated. There is normally one value per day.
get   Get all api keys
get   Get all global auth. module configs
post   Create one global auth. module config
delete   Delete one global auth. module config
get   Get one global auth. module configs
put   Update one global auth. module config
put   Update one global auth. module config
get   Get all certificates
post   Create one certificate
delete   Delete one certificate by id
get   Get one certificate by id
put   Update one certificate by id
put   Update one certificate by id
get   Get all validation authoritiess
post   Create one validation authorities
delete   Delete one validation authorities by id
get   Get one validation authorities by id
put   Update one validation authorities by id
put   Update one validation authorities by id
get   Get all data exporter configs
post   Create a new data exporter config
delete   Delete a data exporter config
put   Update a data exporter configs with a diff
post   Create a new data exporter configs
put   Update a data exporter configs
get   Get all data exporter configs
delete   Delete a data exporter config
get   Get a data exporter config
put   Update a data exporter config with a diff
put   Update a data exporter config
get   Get the full configuration of Otoroshi
put   Update the global configuration with a diff
put   Update the global configuration
get   Get all service groups
post   Create a new service group
get   Get all api keys for the group of a service
post   Create a new api key for a group
delete   Delete an api key for a specified service group
get   Get an api key for a specified service group
put   Update an api key for a specified service descriptor with a diff
put   Update an api key for a specified service group
post   Reset the quota state of an api key
get   Get the quota state of an api key
delete   Delete a service group
get   Get a service group
put   Update a service group with a diff
put   Update a service group
get   Get all services descriptor for a group
post   Import the full state of Otoroshi as a file
get   Get global otoroshi stats
get   Get live feed of global otoroshi stats (global) or for a service {id}
post   Export the full state of Otoroshi
post   Import the full state of Otoroshi
get   Get all scripts
post   Create a new script
post   Compile a script
delete   Delete a script
get   Get a script
put   Update a script with a diff
put   Update a script
get   Get all services
post   Create a new service descriptor
delete   Delete a service descriptor
get   Get a service descriptor
put   Update a service descriptor with a diff
put   Update a service descriptor
get   Get all api keys for the group of a service
delete   Delete an api key for a specified service descriptor
get   Get an api key for a specified service descriptor
put   Update an api key for a specified service descriptor with a diff
put   Update an api key for a specified service descriptor
get   Get the group of an api key
post   Reset the quota state of an api key
get   Get the quota state of an api key
delete   Delete a service descriptor target
get   Get a service descriptor targets
put   Update a service descriptor targets
post   Add a target to a service descriptor
delete   Delete a service descriptor error template
get   Get a service descriptor error template
post   Update a service descriptor targets
put   Update an error template to a service descriptor
post   Start the Snow Monkey
post   Stop the Snow Monkey
get   Get current Snow Monkey config
put   Update current Snow Monkey config
put   Update current Snow Monkey config
post   Reset Snow Monkey Outages for the day
get   Get all current Snow Monkey ourages
get   Get all global JWT verifiers
post   Create one global JWT verifiers
delete   Delete one global JWT verifiers
get   Get one global JWT verifiers
put   Update one global JWT verifiers
put   Update one global JWT verifiers
post   Import the full state of Otoroshi as a file
get   Get all environments provided by the current Otoroshi instance
get   Get all services for an environment provided by the current Otoroshi instance
get   Get a template of an Otoroshi Api Key. The generated entity is not persisted
get   Get a template of an Otoroshi service group. The generated entity is not persisted
get   Get a template of an Otoroshi service descriptor. The generated entity is not persisted
post   Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account's activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.
get   Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.
get   Returns a list of your exports.
post   Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.
post   Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive containing a single file named whitelist.csv that includes the following fields: email, detail, created_at.
put   Add an inbound domain to your account
post   Add a new mailbox route to an inbound domain
post   Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call
delete   Delete an inbound domain from the account. All mail will stop routing for this domain immediately.
delete   Delete an existing inbound mailbox route
post   List the domains that have been configured for inbound delivery
post   List the mailbox routes defined for an inbound domain
post   Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP
post   Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.
post   Cancels the warmup process for a dedicated IP.
post   Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.
post   Creates a pool and returns it. If a pool already exists with this name, no action will be performed.
delete   Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.
delete   Deletes a dedicated IP. This is permanent and cannot be undone.
post   Retrieves information about a single dedicated ip.
get   Lists your dedicated IP pools.
get   Lists your dedicated IPs.
post   Describes a single dedicated IP pool.
post   Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.
post   Configures the custom DNS name for a dedicated IP.
post   Moves a dedicated IP to a different pool.
post   Begins the warmup process for a dedicated IP. During the warmup process, Mandrill will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.
post   Cancels a scheduled email.
get   Get the full content of a recently sent message
get   Get the information for a single recently sent message
get   Queries your scheduled emails by sender or recipient, or both.
post   Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces
post   Reschedules a scheduled email.
post   Search the content of recently sent messages and return the aggregated hourly stats for matching messages
post   Search the content of recently sent messages and optionally narrow by date range, tags and senders. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying.
post   Take a raw MIME document for a message, and send it exactly as if it were sent through Mandrill's SMTP servers
post   Send a new transactional message through Mandrill using a template
post   Send a new transactional message through Mandrill
post   Add a new custom metadata field to be indexed for the account.
delete   Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
post   Get the list of custom metadata fields indexed for the account.
put   Update an existing custom metadata field.
post   Adds an email to your email rejection blacklist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your blacklist. Attempting to blacklist an address that has been whitelisted will have no effect.
delete   Deletes an email rejection. There is no limit to how many rejections you can remove from your blacklist, but keep in mind that each deletion has an affect on your reputation.
get   Retrieves your email rejection blacklist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.
post   Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.
post   Checks the SPF and DKIM settings for a domain. If you haven't already added this domain to your account, it will be added automatically.
get   Returns the sender domains that have been added to this account.
get   Return more detailed information about a single sender, including aggregates of recent stats
get   Return the senders that have tried to use this account.
get   Return the recent history (hourly stats for the last 30 days) for a sender
post   Sends a verification email in order to verify ownership of a domain. Domain verification is an optional step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.
post   Add a new subaccount
delete   Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.
get   Given the ID of an existing subaccount, return the data about it
get   Get the list of subaccounts defined for the account, optionally filtered by a prefix
post   Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.
post   Resume a paused subaccount's sending
put   Update an existing subaccount
get   Return the recent history (hourly stats for the last 30 days) for all tags
delete   Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully.
get   Return more detailed information about a single tag, including aggregates of recent stats
get   Return all of the user-defined tag information
get   Return the recent history (hourly stats for the last 30 days) for a tag
post   Add a new template
delete   Delete a template
get   Get the information for an existing template
get   Return a list of all the templates available to this user
post   Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft.
post   Inject content and optionally merge fields into a template, returning the HTML that results
get   Return the recent history (hourly stats for the last 30 days) for a template
put   Update the code for an existing template. If null is provided for any fields, the values will remain unchanged.
post   Add a tracking domain to your account
post   Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call
get   Get the 100 most clicked URLs
get   Return the 100 most clicked URLs that match the search query given
get   Return the recent history (hourly stats for the last 30 days) for a url
get   Get the list of tracking domains set up for this account
get   Return the information about the API-connected user
post   Validate an API key and respond to a ping
post   Validate an API key and respond to a ping (anal JSON parser version)
get   Return the senders that have tried to use this account, both verified and unverified
post   Add a new webhook
delete   Delete an existing webhook
get   Given the ID of an existing webhook, return the data about it
get   Get the list of all webhooks defined on the account
post   Update an existing webhook
post   Adds an email to your email rejection whitelist. If the address is currently on your blacklist, that blacklist entry will be removed automatically.
delete   Removes an email address from the whitelist.
get   Retrieves your email rejection whitelist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results.
get   List rides
post   Request a Lyft
get   Get the ride detail of a given ride ID
post   Cancel a ongoing requested ride
put   Update the destination of the ride
post   Add the passenger's rating, feedback, and tip
get   Get the receipt of the rides.
post   Preset Prime Time percentage
post   Propagate ride through ride status
post   Preset types of rides for sandbox
get   Get all available markets.
get   Returns associations connecting two entities
post   Fetches popular hashtags or marks tagged with specified hashtag
post   Fetches marks
get   Retrieve Advisors
get   Retrieve Advisors for a Client
get   Retrieve an Advisor
get   Retrieve plan assumptions
get   Retrieve business entities
get   Retrieve a business entity
get   Retrieve Monte Carlo results from standalone calc service
get   Retrieve defined benefit pensions
get   Retrieve a definedBenefitPension
get   Retrieve family
get   Retrieve the adjustments
post   Perform calculations
get   Returns a list of goals with their relevant success rates.
get   Retrieve the adjustments
post   Perform calculations
get   Returns a list of goal adjustment restrictions.
get   Retrieve the adjustments
post   Perform calculations
get   Returns WAMO values for current goal
get   Retrieve goals
get   Retrieve goals
get   Retrieve holding companies
get   Retrieve a holding company
get   Retrieve all Households associated with the user
get   Retrieve liabilities
get   Retrieve a liability
get   Retrieve lifestyle assets
get   Retrieve lifestyle assets
get   Retrieves all goals from the live plan
get   Retrieve a list of funding accounts
get   Retrieve WAMO values for a given goal
get   Retrieves accounts for a given plan
get   Retrieves liabilities for a given plan
get   Retrieves lifestyle assets for a given plan
get   Retrieves real estate accounts for a given plan
get   Retrieves net worth projections
get   Retrieves needs vs abilities projections
get   Retrieve net worth
post   Determines if the currently logged in user has set their own password
get   Gets the password complexity requirements
post   Resets the password for the supplied user name
put   Sets the password for the currently logged in user
get   Retrieve plan information
get   Retrieve plan data statuses
get   Retrieve portfolio accounts
get   Retrieve a portfolio account
get   Retrieve projected annual summaries
get   Retrieve projected annual summary by id
get   Retrieve projected cash flow
get   Retrieve projected cash flow by id
get   Retrieve assets funding goals over time
get   Retrieve needs vs abilities data
get   Retrieve projected net worth
get   Retrieve projected net worth by id
get   Retrieve restricted stocks
get   Retrieve a restricted stock
get   This resource can be used to check the status of the service.
get   Retrieve stock options
get   Retrieve a stock option
post   Start a session with the DomainProviders user store
get   Gets the login rules
post   Validate and extend the duration of a session
post   Create Account Access Consents
delete   Delete Account Access Consents
get   Get Account Access Consents
get   Get Accounts
get   Get Accounts
get   Get Balances
get   Get Beneficiaries
get   Get Parties
get   Get Party
get   Get Scheduled Payments
get   Get Standing Orders
get   Get Statements
get   Get Statements
get   Get Statements
get   Get Transactions
get   Get Transactions
get   Get Party
post   Create Sandbox
post   Import Sandbox
delete   Delete Sandbox
post   Export Sandbox
get   List Licenses
post   Create License
delete   Delete License
get   Get License
put   Update License
get   List Licensees
post   Create Licensee
delete   Delete Licensee
get   Get Licensee
put   Update Licensee
post   Transfer Licenses
post   Validate Licensee
get   List License Templates
post   Create License Template
delete   Delete License Template
get   Get License Template
put   Update License Template
get   List Payment Methods
get   Get Payment Method
put   Update Payment Method
get   List Products
post   Create Product
delete   Delete Product
get   Get Product
put   Update Product
get   List Product Modules
post   Create Product Module
delete   Delete Product Module
get   Get Product Module
put   Update Product Module
get   List Tokens
post   Create token
delete   Delete token
get   Get token
get   List Transactions
post   Create Transaction
get   Get Transaction
put   Update Transaction
get   List License Types
get   List Licensing Models
get   Get Account Balance
get   List Tags from Workgroup and Project.
get   List Files from Project.  Works for Regular and Remote Files
post   Upload File to Project.  A multipart/form-data request with a name "file"
get   Get File from Project.  Works for Regular and Remote Files
get   List a specific spec of project Level
put   Update a specific Spec
post   Invite a team member or all the members of team template for the specific project.
get   Get Spec Type Fields
get   List all countries
get   List the workgroups
get   List current user's automatic invitations info
get   List Billing Recipients
get   List the buy orders of workgroup
get   Get a specific buy order of workgroup
get   List client workgroups
get   Get a specific client workgroups
get   List the project categories of client side
get   List projec home user fields of client workgroup
get   List the project status of client
get   List the contacts
get   Get custom task status of workgroup level
get   Get custom task types of workgroup level
get   List all deactivation reasons
get   Get default task priority list
get   Get default task status list
get   Detail workgroup info
put   Update a specific Workgroup
get   Get Exchange Rate List
post   Create Exchange Rates
get   List my time cards
get   Get a specific my time cards
get   Get product type of workgroup level
get   Get product type of spec level by workgroupId
post   Register product types for spec types
post   Upload Profile Image.  A multipart/form-data request with a name "file"
get   List the project categories
get   List projec home user fields
get   List the project status
get   List the projects
post   Create a Project
post   Archieve a specific Project
get   Get a specific Project
post   Patch a specific Project
put   Update a specific Project
get   List the buy orders
post   Create a quick buy order
get   Get a specific buy order
put   Update a specific buy order
post   Attach children projects to specific Project
get   List the Estimates
post   Create a Estimate
get   Get a specific estimate of project
get   List invoices by a specific order
get   List a specific invoice of project Level
get   List files of invoice Level
get   List all the role options for the user
get   Get a specific buy/sell order
get   List the quotes
get   Get a specific quote of project
get   List the RFES
post   Create a RFE
get   Get a specific Rfe
get   List the rfqs
get   Get a specific Rfq
get   List the sell orders
get   Get a specific sell order
put   Update / Accept or Reject a specific sell order
get   List shipments of project
post   Create a shipment
get   Get a specific shipment.
put   Update a specific shipment location
get   List specs of project Level
post   Create a Spec
get   List a specific spec of project Level
put   Update a specific Spec
get   Get task list of project level
post   Create a new task
get   Get a sepcific task of project level
get   List team member of client project side.
get   List team member of project.
delete   Delete a team member for the specific project.
get   List the quote states
get   List the quotes of workgroup level
get   List received time cards
get   List a specific received time cards
get   List the sell orders of workgrop
get   Get a specific sell order
get   List Spec Templates of Workgroup Level
get   Get a specific Spec Template
get   Get Spec Type Fields
get   List supplier workgroups
get   Get the specific supplier of My Group
get   Get task types of workgroup level
get   Get task list of workgroup level
get   Get a sepcific task of workgroup level
get   List current user's team templates info
get   Get current user's team template detal info
get   List the workgroup members
get   Retrieve a block
post   Show a web-based login/signup form to a user
post   Initiate an OAuth2 login flow for limited input devices
post   Create a new OAuth2 access token
post   Revoke an existing OAuth2 access token
get   Retrieves a list of currently defined APIs in API meta list format.
get   Retrieves an API meta listing of all APIs defined for this owner
delete   Deletes the specified API
get   Retrieves an API meta listing for all API versions for this owner and API
post   Saves the provided Swagger definition
delete   Deletes a particular version of the specified API
post   Publish a particular version of the specified API
get   Retrieves the Swagger definition for the specified API and version in JSON format
get   Retrieves the Swagger definition for the specified API and version in YAML format
post   Log in to OpenAPI space
post   Log in to OpenAPI space using an APInf account
post   Log in to OpenAPI space using an APInf authentication token
post   Log out from OpenAPI space
post   Check whether or not you are authenticated
post   Register to OpenAPI space
get   Get Competitor information by Id
get   Get Competitor information by URL
get   Get Competitor information by Id
get   Get Competitor information by Url
get   Fuzzy Search Company by Name or Address or Phone
get   Get Company by Id
get   Search Company by Ticker or Website or Name or PermID
get   Get Company by URL
get   Get Complete Company Info by Id
get   Get Basic Company Info by Url
get   Get Feeds for given Company Ids
get   Get Feeds for given Company Websites
get   Search mandates
post   Create a new mandate
get   Find mandate by ID
get   Search Direct Debit payments
post   Create new Direct Debit payment
get   Find Direct Debit payment by ID
get   Search payments
post   Create new payment
get   Find payment by ID
post   Cancel payment
post   Capture payment
get   Return payment events by ID
get   Get all refunds for a payment
post   Submit a refund for a payment
get   Find payment refund by ID
get   Search refunds
get   Get templates
post   Create template
post   Generate document (multiple templates)
delete   Delete template
get   Get template
put   Update template
post   Copy template
post   Open editor
post   Generate document
delete   Delete workspace
get   Get workspace
get   Retrieve billing information
put   Partial update billing information
put   Update billing information
post   Action that should be taken to enable the selected targets
post   Estimate costs of updating a subscription
put   Update a subscription
post   Check validity of password reset token
get   List account events
get   Retrieve account event
get   List frameworks
get   Retrieve framework
get   List Jira Projects
get   Retrieve project issue types
get   Retrieve issue priorities
get   Retrieve issue statuses
get   List Jira Projects
get   Retrieve project issue types
get   Retrieve issue priorities
get   Retrieve issue statuses
get   List API keys allowed to operate on account
post   Create account API key
delete   Delete account API key
get   Retrieve account API key
get   List labels
post   Create label
delete   Delete label
get   Retrieve framework
put   Partial update
put   Update label
post   Change user password
post   Send reset password email
post   Reset password after asking for a reset (with the token sent by email).
post   Available actions for the selected targets
get   List targets
post   Create target
post   Activate targets
get   List scans for all targets
get   List scheduled scans for all targets expanding recurrence
post   Archive targets
get   List archived targets
delete   Delete target
get   Retrieve target
put   Partial update target
put   Update target
get   List target's assets
post   Create new asset
delete   Delete asset
get   Retrieve asset
put   Partial update assets
put   Update asset
post   Verify asset ownership
get   List target events
get   Retrieve target event
get   List target findings
get   Finding report
post   Bulk retest findings
put   Bulk update findings
get   Retrieve finding report PDF format
get   Retrieve finding
put   Partial update finding
put   Update finding
get   Retrieve Jira Cloud finding configuration
put   Update Jira Cloud finding configuration
put   Update Jira Cloud finding configuration
get   Retrieve Jira Server finding configuration
put   Update Jira Server finding configuration
put   Update Jira Server finding configuration
get   Finding activity log.
post   Retest finding
get   Retrieve Jira Cloud Target configuration
put   Update Jira Cloud target configuration
put   Update Jira Cloud target configuration
get   Retrieve Jira Server Target configuration
put   Update Jira Server target configuration
put   Update Jira Server target configuration
get   Retrieve slack integration data
put   Update slack integration data
put   Update slack integration data
get   List target specific API keys
post   Create target API key
delete   Delete target API key
get   Retrieve target API key
post   Start a scan on the target
get   List scans
get   Retrieve scan
post   Cancel running scan
get   List scheduled scans
post   Create new scheduled scan
get   List scheduled scans expanding recurrence
delete   Delete
get   Retrieve a scheduled scan
put   Partial update
put   Update a scheduled scan
get   Retrieve target's site
put   Partial update target's site
put   Update target's site
post   Verify site ownership
get   List target webhooks
post   Create new target webhook
delete   Delete target webhook
get   Retrieve target webhook
put   Partial update target webhook
put   Update target webhook
get   List users
post   Create/Reactivate a user.
post   Deactivate a user
get   Retrieve user
put   Partial update user
put   Update user
get   List vulnerability definitions
get   Retrieve vulnerability definition
get   List account webhooks
post   Create new account webhook
delete   Delete account webhook
get   Retrieve account webhook
put   Partial update account webhook
put   Update account webhook
get   Get quotes for all symbols
get   Get a list of symbols for which we provide real-time quotes
post   Performs introspection of the provided Bearer JWT token
get   Retrieves item usages
get   Retrieves sign-in attempts
get   Retrieve a list of API Requests that have been made.
get   Get state of the server and its dependencies.
post   Ping the server for liveness
get   Query server for exposed Prometheus metrics
get   Get all Vaults
get   Get Vault details and metadata
get   Get all items for inside a Vault
post   Create a new Item
delete   Delete an Item
get   Get the details of an Item
put   Update a subset of Item attributes
put   Update an Item
get   Get all the files inside an Item
get   Get the details of a File
get   Get the content of a File
get   Enumerate all active channels of the application
get   Lists apps
post   Creates an app
get   Lists app keys
post   Creates a key
put   Updates a key
post   Revokes a key
get   Lists namespaces
post   Creates a namespace
delete   Deletes a namespace
put   Updates a namespace
get   Lists queues
post   Creates a queue
delete   Deletes a queue
get   Lists Reactor rules
post   Creates a Reactor rule
delete   Deletes a Reactor rule
get   Gets a reactor rule by rule ID
put   Updates a Reactor rule
delete   Deletes an app
put   Updates an app
put   Updates app's APNs info from a `.p12` file
get   Get token details
get   Get information about the current user
post   Send data to a feed via webhook URL.
post   Send arbitrary data to a feed via webhook URL.
get   Get activities by type for current user
post   Create a new Dashboard
post   Create a new Block
delete   Delete an existing Block
get   Returns Block based on ID
put   Update properties of an existing Block
put   Replace an existing Block
delete   Delete an existing Dashboard
get   Returns Dashboard based on ID
put   Update properties of an existing Dashboard
put   Replace an existing Dashboard
post   Create a new Feed
delete   Delete an existing Feed
get   Get feed by feed key
put   Update properties of an existing Feed
put   Replace an existing Feed
get   Get all data for the given feed
post   Create new Data
post   Create multiple new Data records
delete   Delete existing Data
get   Returns data based on feed key
put   Update properties of existing Data
put   Replace existing Data
get   Get detailed feed by feed key
post   Create a new Group
delete   Delete an existing Group
get   Returns Group based on ID
put   Update properties of an existing Group
put   Replace an existing Group
post   Add an existing Feed to a Group
post   Create new data for multiple feeds in a group
post   Create a new Feed in a Group
post   Create new Data in a feed belonging to a particular group
post   Create multiple new Data records in a feed belonging to a particular group
delete   Remove a Feed from a Group
get   Get the user's data rate limit and current activity level.
post   Create a new Token
delete   Delete an existing Token
get   Returns Token based on ID
put   Update properties of an existing Token
put   Replace an existing Token
post   Create a new Trigger
delete   Delete an existing Trigger
get   Returns Trigger based on ID
put   Update properties of an existing Trigger
put   Replace an existing Trigger
post   Create a new Permission
delete   Delete an existing Permission
get   Returns Permission based on ID
put   Update properties of an existing Permission
put   Replace an existing Permission
post   Trigger verification.
post   Close an account.
post   Close an account holder.
post   Close stores.
post   Create a new account.
post   Create a new account holder.
delete   Delete bank accounts.
delete   Delete payout methods.
delete   Delete shareholders.
delete   Delete signatories.
get   Get an account holder.
get   Get a tax form.
get   Get documents.
post   Suspend an account holder.
post   Unsuspend an account holder.
put   Update an account.
put   Update an account holder.
put   Update payout or processing state.
put   Upload a document.
post   Create an account holder.
get   Retrieve an account holder.
put   Update an account holder.
get   Retrieve all balance accounts of a specific account holder.
post   Create a balance account.
get   Retrieve a balance account.
put   Update a balance account.
get   Retrieve all payment instruments for a specific balance account.
get   Retrieve a balance platform.
get   Retrieve all account holders under a specific balance platform.
post   Upload a document for verification checks.
delete   Delete a document.
get   Retrieve a document.
put   Update a document.
post   Create a legal entity.
get   Retrieve a legal entity.
put   Update a legal entity.
post   Create a payment instrument group.
get   Retrieve a payment instrument group.
get   Retrieve all transaction rules for a specific payment instruments group.
post   Create a payment instrument.
get   Retrieve a payment instrument.
put   Update a payment instrument.
get   Retrieve all transaction rules for a specific payment instrument.
post   Create a transaction rule.
delete   Delete a transaction rule.
get   Retrieve a transaction rule.
put   Update a transaction rule.
post   Create a transfer instrument.
delete   Delete a transfer instrument
get   Retrieve a transfer instrument.
put   Update a transfer instrument.
post   Checks 3D Secure availability.
get   Gets a cost estimate.
post   Create originKey values for one or more merchant domains.
get   Retrieve the balance(s) of an account holder.
get   Retrieve a list of transactions.
post   Disburse a specified amount from an account to the account holder.
post   Make a refund of the existing transfer funds transfer.
post   Refund all transactions of an account since the most recent payout.
post   Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary.
post   Transfer funds from one platform account to another.
get   Get a link to a Adyen-hosted onboarding page.
get   Get a link to a PCI compliance questionnaire.
post   Disables stored payment details.
get   Retrieves stored payment details for a shopper.
post   Notify the shopper for upcoming recurring payment
post   Schedules running of the Account Updater.
post   Creates one or more test card ranges.
get   Get all transactions.
get   Get a transaction.
post   Transfer funds.
post   Activate or Deactivate an ECU, or Report an ECU as Damaged.
get   Get injector codes given engine.
post   Report the IQA codes used by an engine
get   Get production calibration data for given engine.
post   Check whether there is connectivity to AGCO Power Web Services
get   Retrieve the status of an EDT Kit Registration with AGCO Power Web Services
put   Update the status of an EDT Kit Registration with AGCO Power Web Services
put   Manage API tokens.
post   Authenticate a user.
post   Request a password reset.
post   Reset a password
get   Get authorization categories.
post   Add an authorization category.
get   Returns a report of access that users have to Authorization Categories.
delete   Remove an authorization category.
put   Update an authorization category.
delete   Deletes a category a user could see.
post   Add a category that a user can see.
get   Get authorization code definitions.
post   Add an authorization code definition.
delete   Deletes the category from the authorization code definition.
post   Add a category to an authorizationCodeDefintion.
post   Disable an authorization code definition
get   Get an authorization code definition by its ID
put   Update an authorization code definition
get   Get authorization codes.
post   Generates an authorization code using the provided definition and parameters.
post   Hide an authorization code.
get   Get an authorization code by its ID.
put   Update an authorization code.
get   Get contact information for an authorization code.
get   Get contact information for authorization codes.
post   Add contact information for authorization code.
get   Gets a list of Brands.
get   Get the list of bundles.
post   Add a Bundle to the Update System.
delete   Delete a Bundle.
get   Get a specific Bundle by ID.
put   Modify a Bundle in the Update System.
get   Get a List of Clients in the Update System.
get   Get a list of Cached Files installed on the client Machine.
get   Get the package reports for a client.
post   Submit a package report
post   Submit a batch of package reports
get   Get a Client in the Update System.
put   Update a Client.
get   Get a Client's Available Update Group Subscriptions
get   Get a Client's Current Update Group Subscriptions
delete   Remove an Attribute from a ContentDefinition
put   Update an Attribute for a ContentDefinition
get   Get ContentDefinitions
post   Create a ContentDefinition
delete   Delete a ContentDefinition
get   Get a ContentDefinition by ID
put   Update a ContentDefinition
get   Get Attributes for a ContentDefinition
post   Add an Attribute to a ContentDefinition
get   Get ContentReleaseVersion
post   Create a ContentReleaseVersion
delete   Delete a ContentReleaseVersion
get   Get a Content Release Version by ID
put   Update a ContentReleaseVersion
delete   Remove an Attribute from a ContentSubmission
put   Update an Attribute for a ContentSubmission
get   Returns available Content Submission Types.
post   Add a Content Submission Type
delete   Remove a Content Submission Type
get   Retrieves a Content Submission Type by its ID.
put   Update a Content Submission Type
get   Get ContentSubmissions
post   Create a ContentSubmission
delete   Delete a ContentSubmission
get   Get a ContentSubmission by ID
put   Update a ContentSubmission
get   Get Attributes for a ContentSubmission
post   Add an Attribute to a ContentSubmission
get   Get a total count of dealers per country
get   Get a list of dealers.
get   Get a paged response of file metadata.
post   Create the metadata for a file before uploading. The State of the File should be 'Created'.
invalid   Mark a file as 'Removed'. Disables download of the file and hides metadata from GET all method
get   Gets a file's metadata.
put   Update the metadata for a file. Size may not be modified by the client.
post   Download the contents of a file. The current State of the File should be 'Available'.
post   Upload the contents of a file. The current State of the File should be 'Created'.
get   Get a paged response of file metadata.
post   Create the metadata for a file before uploading. The State should be 'Created'.
get   Gets a file's metadata.
get   Get a paged response of GlobalImage.
post   Create the metadata for a GlobalImage before uploading. The State should be 'Created'.
invalid   Mark a file as 'Removed'. Disables download of the image and hides metadata from GET all method
get   Gets a GlobalImage's metadata.
put   Update the metadata for an image.
post   Download the contents of a GlobalImage. The current State of the GlobalImage should be 'Available'.
post   Upload the contents of a GlobalImage. The current State of the File for the GlobalImage should be 'Created'.
get   Get a list of the languages for which translations are supported. Returns a PagedResponse of Language objects.
post   Add a Language to support for translations. Accepts a Language object. Returns the Id of the created object.
invalid   Remove a Language from those supported for translations. Marks language as deleted.
get   Get a language by its id. Returns a Language object
put   Update a language’s description. Accepts a Language object.
post   Create a license activation.
post   Register an EDT Lite with the Server
put   Update a license activiation.
post   Confirm that the client has applied the updated license.
get   Gets a list of licenses with the specified criteria.
get   Get a license.
get   Get the API System logs, most recent first.
post   Add a Log entry
get   Get a log by ID
post   Sends an email message.
get   Get all of the Package Types.
post   Add a Package Type.
delete   Delete a Package Type.
get   Get a specific Package Type.
put   Modify a Package Type.
delete   Deletes a package type a user could see.
post   Add a package type that a user can see.
delete   Delete a Package Type to Bundle Relationship.
get   Get all of the Package Type to Bundle Relationships.
post   Add a new Package Type ID to Bundle Relationship.
put   Update a Package Type ID to Bundle Relationship.
get   List Packages.
post   Add a Package to the Update System.
delete   Delete a Package.
post   Find a Package.
put   Modify a Packge to the Update System.
get   List Permissions
post   Adds a Permission
delete   Deletes a Permission
get   Gets a Permission
put   Updates a Permission
get   Get a list of Priority Packages by Client.
post   Add a Priority Package for a Client.
delete   Delete a Priority Package for a Client.
get   Get a Priority Packages for a Client.
get   Get Release
post   Create a Release
get   Get a  Release by ID
delete   Deletes the association between a release and a bundle.
post   Associates the release with a bundle.
put   Update a Release
get   Get a summary of all Packages in a Bundle
get   Get a list of bundles for UpdateGroup.
get   Get Client Information
get   Get the current packages for an update group.
get   Get a Client in the Update System.
get   Get a list of current Client Subscriptions.
get   Get a summary report for a Specific Package
get   Get a list of subscribed clients
get   Get a list of Update Groups.  Update Groups are used by the client to register for a specific type of update.
get   Get data for pie charts in UpdateMetrics.
get   List Roles
post   Adds a User Role
delete   Deletes a User Role
get   Gets a User Role
put   Updates a User Role
get   Get the Permissions for a Role
put   Manage the Permissions for a Role
get   Get all user's in a role
put   Update a Role's users
get   Get a paged response of Global String Definitions.
post   Create StringDefinition object. The originating translation must be provided. Accepts an array of StringDefinition objects. Returns nothing.
put   Update StringDefinition objects. Accepts an array of StringDefinition objects. This endpoint will add StringDefinitionChange objects to the database. The DescriptionForTranslator may not be modified after a String is submitted for translation.
get   Get a paged response of Global String Definitions.
get   Get a paged response of Global String Translations.
put   Update corrections to string translations
get   Get a single translation based upon stringId and languageId
put   Update a string value or a state for a string translation.
get   Get a paged response of TranslationKeys.
post   Create a translationKey object.
get   Get TranslationKey by ID
put   Update the StringID of the translationKey object.
get   Get all TranslationRequest objects. Returns a PagedResponse of TranslationRequest objects with their language ids and string ids.
invalid   Create a translation request. Accepts a TranslationRequest object. Returns the Id of the created object. The state of the TranslationRequest must be ‘NotSubmitted’.
get   Get a TranslationRequest object by id. Returns TranslationRequest object with its language ids and string ids.
put   Update a TranslationRequest object by id. Accepts a TranslationRequest object.
delete   Delete a set of TranslationSetAttribute object
put   Update a TranslationSetAttribute object
get   Get a PagedResponse of TranslationSet objects. Related TranslationSetStrings are NOT returned
get   Get a TranslationSet object by its id. Related TranslationSetStrings are NOT returned.
put   Update a Translation Set. Accepts a TranslationSet object. Only the state property may be updated.
get   Get a PagedResponse of TranslationSetAttribute objects
post   Create a TranslationSetAttribute object
get   Gets the information needed to translate a string in a translation set
get   Gets the statistics for translation sets such as the language ids and count of string definitions.
get   Get a PagedResponse of TranslationSetString objects
get   Get a list of current Client Subscriptions.
post   Add a subscription
put   DEPRECATED. Set client subscription status for an update group.
get   Get a subscription by RelationshipID
put   Updates a Subscription
get   Get Update Group Subscriptions
post   Add an Update Group Subscription
delete   Delete an Update Group Subscription
get   Get an Update Group Subscription
put   Update an Update Group Subscription
get   Get a list of Update Groups.  Update Groups are used by the client to register for a specific type of update.
post   Add a new Update Group.  The report field is a string that has a dot based request for a specific piece of submitted data.
delete   Delete an Update Group.
get   Get a specific Update Group by ID.
put   Modify an Update Group.
get   Get a list of bundles for UpdateGroup.
delete   Deletes an update group a user could see.
post   Add an updateGroup that a user can see.
post   Checks the Client ID into the Update System.
get   Get UserContentDefinitions
post   Create a UserContentDefinition
delete   Delete a UserContentDefinition
get   Get a UserContentDefinition by ID
get   Get users
post   Create a user
get   Gets the current user
put   Update a user
get   Get a user's permissions
get   Gets the current user's roles
delete   Delete a user
get   Get a specific user
put   Update a user
get   Get a user's permissions
get   Get a user's roles
put   Update a user's roles
get   Gets voucher history data
get   Gets a list of vouchers
post   Create a voucher
delete   Delete a voucher
get   Get a voucher
put   Update a voucher
get   Get a voucher's history.
get   Get Activities
post   Create an Activity
put   Mark the delete flag for the Activity
get   Get an Activity by ID
put   Update an Activity
get   Get ActivityRuns
get   Get an ActivityRun by ID
put   Update an ActivityRun
get   Get the ActivityRunStatus of an ActivityRun
put   Update the ActivityRunStatus of an ActivityRun
get   Get Agents
post   Create an Agent
get   Get Agent associated with the current user
get   Get the ActivityRun of Agent associated with the current user
delete   Delete an Agent
get   Get Agent
put   Update an Agent
get   Get an Agent's ActivityRun
put   Update the ActivityRun assigned to the Agent.
put   Update an Agent
get   Get JobRuns
post   Create a JobRun
delete   Delete a JobRun
get   Get a JobRun by ID
put   Update a JobRun
get   Get Jobs
post   Create a Job
put   Mark the delete flag for the Job
get   Get a Job by ID
put   Update a Job
get   Get Steps
post   Create a Step
get   Get a Step by ID
put   Update a Step