Away 10:10 PM

2 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

Status — cloud.docs

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Properties

NameTypeRequiredDescription
codeintegerfalseThe status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
messagestringfalseA developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
detailsarrayfalseA list of messages that carry the error details. There is a common set of message types for APIs to use.

Complete Schema

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].",
      "format": "int32"
    },
    "message": {
      "type": "string",
      "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."
    },
    "details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GoogleProtobufAny"
      },
      "description": "A list of messages that carry the error details.  There is a common set of message types for APIs to use."
    }
  },
  "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)."
}