The Content-Length header or a content_length property in the body could not be deserialized. This is most likely due to a negative value being passed or a value out of bounds of a standard signed 64-bit integer.

API Bad Header

API_BAD_HEADER

A request header could not be deserialized.

API Bad Headers

API_BAD_HEADERS

The request headers could not be deserialized.

API Bad Query

API_BAD_QUERY

The request query could not be deserialized.

API Bad Query Parameter

API_BAD_QUERY_PARAMETER

An invalid parameter value was passed to a given query parameter. This is usually when an unknown enum variant is passed to an enum parameter.

API Bad Body

API_BODY_TOO_LARGE

The request body could not be deserialized or has an unknown size.

API CORS Header Not Allowed

API_CORS_HEADER_NOT_ALLOWED

The request has a header which is not allowed by the CORS policy set by the requested API.

API CORS Method Not Allowed

API_CORS_METHOD_NOT_ALLOWED

The request uses a method which is not allowed by the CORS policy set by the requested API.

API CORS Origin Not Allowed

API_CORS_ORIGIN_NOT_ALLOWED

The request comes from an origin which is not allowed by the CORS policy set by the requested API.

API Forbidden

API_FORBIDDEN

The user is not allowed to access the requested resource.

API Invalid IP

API_INVALID_IP

The remote address provided by the x-forwarded-for header is not a valid IP address.

API Method Not Allowed

API_METHOD_NOT_ALLOWED

The request uses a method which is not allowed by the requested API. This differs from "API CORS Method Not Allowed" in that it was not caused by CORS validation.

API Missing Header

API_MISSING_HEADER

A request header is required but missing.

API Not Found

API_NOT_FOUND

The requested endpoint was not found.

API Rate Limit

API_RATE_LIMIT

The user has sent too many requests and has triggered a rate limit.

API Unauthorized

API_UNAUTHORIZED

The user is not authorized for the reason given, or the user did not provide a bearer token to authenticate with.

A bearer token is a token in the Authorization header that follows the form Authorization: Bearer <token>. The prefix, "Bearer ", is required.

Billing Not Enabled

BILLING_NOT_ENABLED

Billing is not enabled.

Build Not Found

BUILD_NOT_FOUND

Build not found for given ID.

Build Not Found With Tags

BUILD_NOT_FOUND_WITH_TAGS

Build not found for given tags.

Build Tags Missing Exclusive Key

BUILD_TAGS_MISSING_EXCLUSIVE_KEY

Provided exclusive key that's not in the tags.

Build Tags Null Exclusive Key

BUILD_TAGS_NULL_EXCLUSIVE_KEY

Null value keys cannot be marked as exclusive.

Captcha Failed

CAPTCHA_CAPTCHA_FAILED

The captcha response did not pass the given Captcha.

Captcha Invalid

CAPTCHA_CAPTCHA_INVALID

The given captcha does not apply to this resource.

Captcha Required

CAPTCHA_CAPTCHA_REQUIRED

A captcha was required but not provided in the request.

Entitlement Expired

CLAIMS_ENTITLEMENT_EXPIRED

The requestee's entitlement claims are no longer valid and must be refreshed or recreated.

Missing Entitlement

CLAIMS_MISSING_ENTITLEMENT

A required entitlement claim is missing.

Script Not Found

CLI_SCRIPT_NOT_FOUND

Add the script under the scripts config in rivet.yaml.

Device Link Already Complete

CLOUD_DEVICE_LINK_ALREADY_COMPLETE

Hostname Taken

CLOUD_HOSTNAME_TAKEN

The given hostname has already been taken.

Cloud Invalid Config

CLOUD_INVALID_CONFIG

The given config was invalid.

Too Many Pending Hostnames

CLOUD_TOO_MANY_PENDING_HOSTNAMES_FOR_GROUP

The limit for pending hostnames for the given group has been reached. Please wait until they have been resolved before attempting to add another hostname.

Cloudflare Error

CLOUDFLARE_ERROR

An error was returned by a cloudflare API and has been re-routed to this error response.

Environment Not Found

ENVIRONMENT_NOT_FOUND

The requested environment was not found.

Feature Disabled

FEATURE_DISABLED

A feature required to use/access this resource is disabled.

Glob Invalid

GLOB_INVALID

Invalid glob pattern given

Group Already Member

GROUP_ALREADY_MEMBER

The identity is already a member of the request/related group.

Group cannot request join

GROUP_CANNOT_REQUEST_JOIN

Cannot create a join request for this group. This is usually because the group is of "open" publicity and can simply be joined instead.

Group Deactivated

GROUP_DEACTIVATED

The developer group has been deactivated. Please contact support if you believe this is a mistake.

Reason: `NoPaymentMethod`

A developer group requires a payment method for using Rivet services.

How to check your billing info:

Visit https://hub.rivet.gg/
Select the project you are experiencing this error with.
Click Settings in the top right corner of your project's banner.
Click Billing in the left sidebar.

Reason: `PaymentFailed`

One of the payments made by the developer group has failed. Please view the billing page to investigate further.

How to check your billing info:

Visit https://hub.rivet.gg/
Select the project you are experiencing this error with.
Click Settings in the top right corner of your project's banner.
Click Billing in the left sidebar.

If needed, feel free to contact support for further assistance.

Reason: `Banned`

The developer group has been banned from using Rivet services. Please contact support if you believe this is a mistake.

No reason given

If this error did not come with a reason, contact the developer group to let them know you have experienced the error.

Group Invalid Developer Status

GROUP_ENTERPRISE_RESTRICTION

The current developer status of the given group prevents this action.

Failed to consume group invite

GROUP_FAILED_TO_CONSUME_INVITE

An attempt to use a group invite failed for an unknown reason.

Group Full

GROUP_FULL

The group is full and another member cannot be added.

Group Insufficient Permissions

GROUP_INSUFFICIENT_PERMISSIONS

The identity that created this request does not have sufficient permissions in the related group.

Group invite code already used

GROUP_INVITE_CODE_ALREADY_USED

Invite code max use limit reached.

Group invite code expired

GROUP_INVITE_CODE_EXPIRED

The given invite code is expired.

Group invite code invalid

GROUP_INVITE_CODE_INVALID

The given invite code is invalid.

Group invite code revoked

GROUP_INVITE_CODE_REVOKED

The given invite code is revoked.

Group Join Request Already Exists

GROUP_JOIN_REQUEST_ALREADY_EXISTS

A group the user is requesting to join already has a join request from that user.

Group Member Banned

GROUP_MEMBER_BANNED

The identity that created this request is banned from the related group.

Group Not Found

GROUP_NOT_FOUND

A group with the given ID could not be found.

Group Not Joinable

GROUP_NOT_JOINABLE

The group attempting to be joined does not allow anyone to join it.

Group Not Member

GROUP_NOT_MEMBER

The identity is not a member of the request/related group.

Identity Not Admin

IDENTITY_NOT_ADMIN

The identity requesting this endpoint is not an admin.

Identity Not Found

IDENTITY_NOT_FOUND

The requested identity does not exist or is not visible to whoever is requesting.

Identity Not Registered

IDENTITY_NOT_REGISTERED

The identity that created this request is not registered.

Wrong Identity

IDENTITY_WRONG_IDENTITY

The given resource is not available for the current identity.

Project Not Found

PROJECT_NOT_FOUND

The requested project could not be found.

Region Not Found

REGION_NOT_FOUND

The requested region was not found.

Hostname Already Exists

ROUTE_HOSTNAME_ALREADY_EXISTS

The hostname you're trying to use for this route is already being used by another environment.

invalid_hostname

ROUTE_INVALID_HOSTNAME

The hostname provided for the route is invalid. Route hostnames must follow a specific format and adhere to DNS standards.

Details

Route hostnames must meet the following requirements:

Follow the format {subdomain}.{domain_job}
The subdomain must be at least 4 characters long
The subdomain must be at most 63 characters long (DNS limitation)
The entire hostname must be at most 253 characters (DNS limitation)
The subdomain must contain only lowercase letters, numbers, and hyphens
The subdomain must not start or end with a hyphen
The subdomain must not contain consecutive hyphens
The domain must match the configured domain_job in your environment

Examples

If your domain_job is job.example.com:

Invalid:

abc.job.example.com (subdomain too short)
my_app.job.example.com (invalid character)
myapp.other-domain.com (wrong domain)
-myapp.job.example.com (starts with hyphen)
myapp-.job.example.com (ends with hyphen)
my--app.job.example.com (consecutive hyphens)

Valid:

myapp.job.example.com
api-v1.job.example.com
my-service-123.job.example.com

invalid_name_id

ROUTE_INVALID_NAME_ID

The name_id provided for the route is invalid. Route name_ids must be lowercase alphanumeric or dashes without repeating double dashes, and are limited to 16 characters.

Details

Name IDs are used to uniquely identify routes within a namespace and must follow specific formatting rules.

Make sure your name_id:

Contains only lowercase letters (a-z), numbers (0-9), and hyphens (-)
Does not contain consecutive hyphens (--)
Does not start or end with a hyphen
Is 16 characters or less

Examples

Invalid: UPPERCASE-route, route--name, -route-name, route-name- Valid: my-route, route-123, api-v2

invalid_path

ROUTE_INVALID_PATH

The path provided for the route is invalid. Route paths must follow specific formatting rules.

Details

Route paths must meet the following requirements:

Must start with a forward slash (/)
Must not end with a forward slash (/) unless it's the root path (/)
Must not contain consecutive slashes (//)
Can have at most 8 path components
Total length must not exceed 256 characters
Each path component:
- Must not be empty
- Must not be longer than 64 characters
- Must contain only alphanumeric characters, hyphens (-), underscores (_), or dots (.)
- Must not start or end with a dot
- Must not contain consecutive dots (..)

Examples

Invalid:

api/v1 (doesn't start with slash)
/api/v1/ (ends with slash)
/api//v1 (contains consecutive slashes)
/api/v1/users/posts/comments/likes/replies/authors/extra (too many components)
/invalid~path (invalid character)
/api/.hidden (component starts with dot)
/api/hidden. (component ends with dot)
/api/config..json (component contains consecutive dots)
/component-name-that-is-way-too-long-and-exceeds-the-maximum-allowed-length-for-a-path-component (component too long)

Valid:

/
/api
/api/v1
/api/v1/users
/api/v1/users/config.json
/api/v1/users/my-service_name

invalid_selector_tags

ROUTE_INVALID_SELECTOR_TAGS

The selector_tags provided for the route are invalid. Route selector tags must follow specific validation rules.

Details

Route selector tags must meet the following requirements:

Maximum of 8 key-value pairs
Keys cannot be empty and must be 32 bytes or less
Values cannot be empty and must be 1024 bytes or less

Selector tags are used to match routes to specific actors or services based on their tags. Having proper validation ensures reliable routing.

Examples

Invalid:

More than 8 key-value pairs
Empty key: {"": "value"}
Key too long: {"this_key_is_way_too_long_and_exceeds_the_32_byte_limit": "value"}
Empty value: {"key": ""}
Value too long: A value exceeding 1024 bytes

Valid:

{"version": "v1"}
{"service": "auth", "environment": "prod"}

Invalid Target

ROUTE_INVALID_TARGET

The route target configuration is invalid.

not_found

ROUTE_NOT_FOUND

The requested route could not be found.

Details

This error occurs when attempting to access, update, or delete a route that does not exist or has been deleted. Routes are identified by either their UUID or by a combination of namespace ID and name ID.

Examples

This error might occur when:

The route ID provided is invalid or does not exist
The namespace and name ID combination does not match any active route
The route has been deleted (has a delete_ts timestamp)

This may be because the token has been manually revoked or already used to refresh another token.

Errors

Reason: NoPaymentMethod

Reason: PaymentFailed

Reason: Banned

No reason given

Reason: `NoPaymentMethod`

Reason: `PaymentFailed`

Reason: `Banned`