Response status and error codes

Loading...

This page describes the response status and error codes available with the Unity API.

Response codes

HTTP response status codes indicate whether a specific request has been successfully completed. When you send a request to an API endpoint, Unity returns one of the following responses:

• 2xx to indicate your request succeeded.
• 4xx to indicate your request failed.
• 5xx to indicate an error with Unity's servers. To check that the service you want to reach is operational, go to the Unity Service Status page.

Error attributes

Error attributes include error information and related metadata such as links to related documentation.

• title

  string

  A short summary of the problem type.

• detail

  string

  A message providing more details about the error returned.

• code

  number

  A number that identifies the error returned.

• type

  string

  Returns a link to the documentation with more information.

• status

  number

  A status code generated by the server.

• details

  array

  An array of additional errors.

• requestId

  string

  The universally unique identifier (UUID) of your request.

Error codes

Depending on your original request, you can receive one of the following error codes:

Code	Status code	Error	Description
0	500	Unknown	Returns an unknown error.
1	500	TransportError	DNS, TLS, and other transport errors that return an invalid response.
2	504	Timeout	The request timed out because no response was received in the time provided.
3	503	ServiceUnavailable	The service is unavailable or overloaded. Try again later.
4	404	ApiMissing	The API does not exist.
5	500	RequestRejected	The request was rejected before reaching the API.
50	429	TooManyRequests	You're making multiple requests too frequently. Make your requests at a lower rate.
51	401	InvalidToken	The authentication token provided is invalid. Generate a new authentication token and try again.
52	401	TokenExpired	The authentication token provided is expired. Generate a new authentication token and try again.
53	403	Forbidden	You don't have permission to perform this operation.
54	404	NotFound	The target resource couldn't be found.
55	400	InvalidRequest	Part of the request is invalid.
56	403	NoPermission	You don't have any permissions
57	N/A	UnprocessableEntity	The content type and syntax of your request is correct, but the instructions are unprocessable.
58	N/A	Conflict	This request conflicts with the current state of the target resource.
59	424	Failed Dependency	The requested action can't be performed because a dependent action has failed.
60	400	MethodNotAllowed	The target resource doesn't support this request method.
61	400	PayloadTooLarge	The request entity is larger than the limits defined by the server.
62	400	UnsupportedMediaType	The payload format is not supported.
44000	422	Some users don't have a UnityID	When adding users to a project, all the emails listed must have a UnityID. If a user doesn't have a UnityID, they must create one before they can be added to a project.
44001	404	One of the accounts is not found.	When setting add-on policies in bulk, if one of the specified accounts is not found, this error will be throw. In case of the Service Account, it might not exist at all or might not belong to the organization. In case of the User, it might not exist or might be deleted.
44002	404	One of the roles is not found	Happens when setting add-on policies in bulk. One of the roles does not exist or has been deleted
44003	422	One of the roles cannot be assigned to {entityType}	Happens when setting add-on policies in bulk. One of the roles cannot be assigned to {entityType}
44004	422	One of the roles is not of the entity type: {entityType}	Happens when setting add-on policies in bulk if one of the roles specified in the payload is not of the entity type specified in the payload.
44005	422	One of the roles is not of the suite: {suiteId}	Happens only if suiteId optional payload parameters is specified. Happens when setting add-on policies in bulk if one of the roles specified in the payload is not of the suite specified in the payload.
44006	422	This API only supports add-on roles	Happens when setting add-on policies in bulk if one of the roles specified in the payload is not an add-on role.
44007	422	The roles in {suiteId} suite must be mutually exclusive.	Happens when setting add-on policies in bulk. Happens if the payload contains multiple roles from the same suite and the roles in the suite are mutually exclusive.
44008	409	Policy for the provided role ids already exists.	Happens when setting add-on policies in bulk. Happens if for some reason the policy for some of the provided role ids already exists.