CodeGuard provides an API for business partners and applications to interact with CodeGuard users and backups. The API uses REST conventions and returns all data in JSON format. Requests may be made using the HTTPS protocol and must be authenticated using a Partner API key or an individual users' credentials.

Definitions and Terminology

Partner: An individual or organization with a registered CodeGuard Partner API key. Partners may build applications, plugins or extensions which can create CodeGuard users. However, once the user has been created, the partner cannot perform any actions on their behalf, but may be able to delete the account.

Partner API Key: This API key is provided by CodeGuard to selected partners. It must be included with each request for authentication.

API User: A user who interacts with CodeGuard via a pre-shared OAuth access key.