Our Partnership API allows New Relic partners, and New Relic accounts set up as customer partnerships, to manage accounts, users, and subscription-related settings.
Requirements
The Partnership API is not available to your organization unless you're specifically instructed by your New Relic representative that you should use it.
The Partnership API can be used by two types of New Relic accounts: partners (managed service providers, resellers) and customer partnerships (larger customers who have been given access to our partnership account structure).
These docs are for version 2 of the Partner API. Earlier versions have been deprecated. If you have problems with an older integration, upgrade to version 2.
Partnership API calls require authentication with both your partnership owner account's REST API key and your Partner ID.
Accounts that are genuine New Relic partners (managed service providers, resellers) have no restrictions on using the API. Accounts set up as customer partnerships have restrictions that follow.
Customer partnership restrictions
If your New Relic organization is set up as a customer partnership, there are some restrictions in place if your organization is on our newer pricing model or our newer user model. Details:
- Pricing model. If you’re on the New Relic One pricing model, you can't use API calls that govern our original pricing model. The API impacts are:
- You can't use the subscription object
- You can't use the NerdGraph Provisioning API.
- User model. If your New Relic organization has had its users converted to be on the New Relic One user model, you can no longer use API calls that create or govern users on our original user model. The API impacts are:
- You can't use the user object. Instead, you'd manage users with these user management docs.
- For the account object: you can't add users via the
usersfield. Instead, you'd manage users with these user management docs.
To determine your pricing model or user model, see Overview of pricing and user model changes.
Password requirements
Passwords passed for account creation have these requirements:
- 8 to 50 characters in length
- Only contain letters, numbers, or special characters
- Cannot contain spaces
- Must contain at least 1 letter
- Must contain at least 1 number or special character
Things you can do
Here is an overview of the API's functionality.
Account:
The account object is what you use to create and update accounts. You can do the following with it:
- Create new
- Show
- Update
- Cancel
- Show usage
- Set primary admin (some accounts)
- Set subscription (some accounts)
There is also a child account object for creating child accounts.
Users:
Some organizations that meet the requirements can use the user object to:
- Add user access to account
- Remove user access from account
Subscription:
Organizations that meet the requirements and are on our original product pricing model can use the subscription object to configure various subscription-related traits.
Get started
To start using the Partnership API, see the Partner API reference docs.