Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.go.gbgplc.com/llms.txt

Use this file to discover all available pages before exploring further.

All error responses follow the GBG standard error format. Every response includes an X-Request-ID header that you can provide to GBG support for troubleshooting.

​
Error response format

JSON
{
  "errors": [
    {
      "code": "4002",
      "name": "MISSING_FIELD",
      "location": "Body",
      "problem": "Either resourceId or deliveryId is required",
      "action": "Please provide resourceId (e.g., 'my-delivery@latest') or deliveryId"
    }
  ]
}

​
Error response fields

FieldDescription
codeNumeric error code (as a string).
nameMachine-readable error identifier (for example, MISSING_FIELD).
locationWhere the error originated: Body, Authorization, Path, or Service.
problemHuman-readable description of what went wrong.
actionWhat you should do to resolve the error.

​
HTTP status codes

The GBG GO API returns standard HTTP status codes to indicate whether a request was successful or failed:
  • 400 Bad request: The request is invalid or missing required parameters. Check your request body, confirm all required fields are included, and verify the expected data format.
  • 401 Unauthorized: The request does not include a valid authentication token, or the token has expired. Include the Bearer token in the Authorization header. If expired, follow the Authentication guide to generate a new one.
  • 403 Forbidden: The account does not have permission to access the requested resource. Check with your administrator to confirm your account has the correct permissions.
  • 404 Not found: The requested resource or endpoint does not exist. Verify you are calling the correct endpoint and check for typos in the URL.
  • 405 Method not allowed: The HTTP method used is not supported for this endpoint. Review the API reference to confirm the correct HTTP method.
  • 500 Internal server error: Something went wrong on the API server. Retry after a few moments. If the issue persists, contact support.
  • 503 Service unavailable: The API service is temporarily unavailable. Wait a few minutes and retry your request.

​
Troubleshooting steps

If your API request fails, follow these steps to diagnose and fix the issue:
  1. Check authentication: Confirm you have included a valid Bearer token in the Authorization header. If expired, request a new one using the Authentication guide.
  2. Validate request data: Make sure all required parameters are included and formatted correctly. If unsure about the expected structure, refer to the API reference.
  3. Confirm the correct endpoint: Double-check the endpoint URL and ensure you are using the correct HTTP method.
  4. Read the error response: The problem and action fields in the error response tell you exactly what went wrong and how to fix it. Use the X-Request-ID header value when contacting support.
  5. Check for service disruptions: If you receive a 500 or 503 error, the API may be experiencing issues. Check the system status page for maintenance notifications.
  6. Contact support: If the issue persists, reach out to GBG support. Include the X-Request-ID, request method, endpoint, request body, and full error response to help diagnose the problem.