RallyHere

https://docs.rallyhere.gg/
Admin
RallyHere is a platform offering a comprehensive suite of backend game services, including...
Tokens:708,187
Snippets:4,214
Trust Score:6.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-guide-by-id

Example command to retrieve a guide using cURL.

```bash
curl -L 'https://demo.rally-here.io/guide/v1/guide/:guide_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-entity-favorite-guide

Example command to retrieve favorite guides using cURL.

```bash
curl -L 'https://demo.rally-here.io/guide/v1/:entity_type/:entity_id/favorite-guide' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-entity-guide-engagement

Example command to retrieve guide engagement using cURL.

```bash
curl -L 'https://demo.rally-here.io/guide/v1/:entity_type/:entity_id/guide-engagement' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "guides": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'
```

--------------------------------

### Search Guides GET Request

Source: https://docs.rallyhere.gg/environment-api-reference/search-guides

Endpoint for retrieving a list of guides based on specified query parameters.

```http
GET 
## https://demo.rally-here.io/guide/v1/guide
```

--------------------------------

### GET /guide/v1/guide

Source: https://docs.rallyhere.gg/environment-api-reference/search-guides

Search all guides based on various filters and sorting criteria.

```APIDOC
## GET /guide/v1/guide

### Description
Search all guides. Requires permissions: `guide:*` or `guide:read`.

### Method
GET

### Endpoint
https://demo.rally-here.io/guide/v1/guide

### Parameters
#### Query Parameters
- **sort_by** (SearchGuideSort) - Optional - Sort by `created`, `modified`, or `upvotes`. Default: `created`.
- **sort** (SortDirection) - Optional - Sort direction `asc` or `desc`. Default: `desc`.
- **cursor** (any) - Optional - Pagination cursor.
- **page_size** (integer) - Optional - Number of items per page. Default: `20`.
- **owner_entity_type** (any) - Optional
- **owner_entity_id** (any) - Optional
- **language** (any) - Optional
- **guide_type** (any) - Optional
- **game_version** (any) - Optional
- **name** (any) - Optional
- **ref_1** through **ref_32** (any) - Optional - Reference fields for filtering.

### Response
#### Success Response (200)
- **Content-Type** (application/json) - Successful response containing the list of guides.
```

--------------------------------

### cURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/search-guides

A basic cURL command to fetch guides from the API using a Bearer token.

```bash
curl -L 'https://demo.rally-here.io/guide/v1/guide' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get Overlay via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/overlay-get-overlay

Example request using the cURL command-line tool.

```bash
curl -L '/api/v1/product/:product_id/overlay/:overlay_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get All Environments cURL Request

Source: https://docs.rallyhere.gg/developer-api-reference/environment-get-all-environments

Example command to retrieve environments for a specific product using cURL.

```bash
curl -L '/api/v1/product/:product_id/environment' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### POST /guide/v1/guide

Source: https://docs.rallyhere.gg/environment-api-reference/create-guide

Creates a new guide in the system. Requires specific permissions: guide:*, guide:write:any, or guide:write:self.

```APIDOC
## POST /guide/v1/guide

### Description
Create a new guide.

### Method
POST

### Endpoint
https://demo.rally-here.io/guide/v1/guide

### Request Body
- **guide_type** (string) - Required - <= 16 characters
- **language** (string) - Required - <= 3 characters
- **game_version** (string) - Required - <= 64 characters
- **name** (string) - Required - non-empty and <= 128 characters
- **short_desc** (string) - Optional - <= 512 characters
- **ref_1** through **ref_32** (string) - Optional - <= 64 characters
- **content** (string) - Optional - <= 16384 characters
- **sections** (array) - Optional - <= 16 items

### Permissions
- For any entity: guide:*, guide:write:any
- For the entity themselves: guide:write:self
```

--------------------------------

### Get Guide By Id Request

Source: https://docs.rallyhere.gg/environment-api-reference/get-guide-by-id

The endpoint for retrieving guide details via a GET request.

```http
GET 
## https://demo.rally-here.io/guide/v1/guide/:guide_id
```

--------------------------------

### Initialize

Source: https://docs.rallyhere.gg/unreal-plugins/GameInstance

Initializes the bootstrapper.

```APIDOC
## Initialize

### Description
Initializes the bootstrapper.

### Method
void Initialize()
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/developer-api-reference/get-ranks-history

Example command to perform the GET request using cURL.

```bash
curl -L '/api/v1/history/sandbox/:sandbox_id/rank' \
-H 'Accept: application/json'
```

--------------------------------

### cURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-all-map-game-info

Example command to retrieve instance launch template data using cURL.

```bash
curl -L 'https://demo.rally-here.io/session/v1/instance-launch-templates/:instance_launch_template_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Delete Guide via cURL

Source: https://docs.rallyhere.gg/environment-api-reference/delete-guide-by-id

Example command to delete a guide using cURL.

```bash
curl -L -X DELETE 'https://demo.rally-here.io/guide/v1/guide/:guide_id' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### POST /guide/v1/guide

Source: https://docs.rallyhere.gg/environment-api-reference/create-guide

Creates a new guide with the specified metadata, content, and sections.

```APIDOC
## POST /guide/v1/guide

### Description
Creates a new guide entry in the system.

### Method
POST

### Endpoint
https://demo.rally-here.io/guide/v1/guide

### Request Body
- **guide_type** (string) - Required
- **language** (string) - Required
- **game_version** (string) - Required
- **name** (string) - Required
- **short_desc** (string) - Required
- **content** (string) - Required
- **sections** (array) - Required - List of section objects containing section_type, name, short_desc, content, and reference fields (ref_1 through ref_32).
- **ref_1** through **ref_32** (string) - Optional - Reference fields for the guide.

### Request Example
{
  "guide_type": "string",
  "language": "string",
  "game_version": "string",
  "name": "string",
  "short_desc": "string",
  "content": "string",
  "sections": [
    {
      "section_type": "string",
      "name": "string",
      "short_desc": "string",
      "content": "string"
    }
  ]
}
```

--------------------------------

### Item Response Schema Example

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-item-by-id

Example JSON structure returned by the Get Item By Id endpoint.

```json
{
  "custom_data": {},
  "name": "string",
  "description": "string",
  "item_type": "unit",
  "entitled_loot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "level_xp_table_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "level_vendor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "inventory_bucket_use_rule_set_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "coupon_discount_percentage": 0,
  "coupon_consume_on_use": true,
  "coupon_discount_loot": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "coupon_discount_currency_item_name": "string",
  "coupon_discount_currency_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "total_ownership_max": 0,
  "legacy_item_id": 0,
  "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "last_modified_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "last_modified_timestamp": "2024-07-29T15:51:28.071Z",
  "created_timestamp": "2024-07-29T15:51:28.071Z",
  "item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "entitled_loot_name": "string",
  "level_vendor_name": "string",
  "level_xp_table_name": "string",
  "inventory_bucket_use_rule_set_name": "string"
}
```

--------------------------------

### GET /guide/v1/guide

Source: https://docs.rallyhere.gg/environment-api-reference/search-guides

Retrieves a list of guides based on the provided query parameters, supporting filtering by owner, language, game version, and custom references.

```APIDOC
## GET /guide/v1/guide

### Description
Retrieves a list of guides based on the provided query parameters, supporting filtering by owner, language, game version, and custom references.

### Method
GET

### Endpoint
/guide/v1/guide

### Parameters
#### Query Parameters
- **sort_by** (string) - Optional - Sort results by created, modified, or upvotes.
- **sort** (string) - Optional - Sort order: asc or desc.
- **cursor** (string) - Optional - Pagination cursor.
- **page_size** (integer) - Optional - Number of items per page.
- **owner_entity_type** (string) - Optional - Filter by owner entity type.
- **owner_entity_id** (string) - Optional - Filter by owner entity ID.
- **language** (string) - Optional - Filter by language.
- **guide_type** (string) - Optional - Filter by guide type.
- **game_version** (string) - Optional - Filter by game version.
- **name** (string) - Optional - Filter by guide name.
- **ref_1** through **ref_32** (string) - Optional - Filter by specific reference fields.

### Response
#### Success Response (200)
- **results** (array) - List of guide objects.
- **cursor** (string) - Pagination cursor for the next page.

### Response Example
{
  "results": [
    {
      "guide_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "owner_entity_type": "player",
      "owner_entity_id": "string",
      "created": "2023-01-23T21:07:02.000000+00:00",
      "modified": "2023-01-23T21:07:02.000000+00:00",
      "favorites": 0,
      "upvotes": 0,
      "downvotes": 0,
      "etag": "string"
    }
  ],
  "cursor": "string"
}
```

--------------------------------

### StartPlatformSession

Source: https://docs.rallyhere.gg/unreal-plugins/Session

Initiates the start of the platform session.

```APIDOC
## StartPlatformSession

### Description
Marks the session as started. Note that this operation is asynchronous.

### Signature
`bool StartPlatformSession()`
```

--------------------------------

### Get Player Referrer CURL Request

Source: https://docs.rallyhere.gg/environment-api-reference/get-player-referrer

Example command to perform the GET request using cURL.

```bash
curl -L 'https://demo.rally-here.io/friends/v2/player/:player_uuid/referrer' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get Role CURL Request

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-role-for-sandbox-and-role-id

Example of how to perform the GET request using the curl command-line tool.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/role/:role_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Create Guide API Request

Source: https://docs.rallyhere.gg/environment-api-reference/create-guide

Use this cURL command to create a new guide. Ensure you replace <TOKEN> with your valid Bearer token.

```bash
curl -L 'https://demo.rally-here.io/guide/v1/guide' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "guide_type": "string",
  "language": "string",
  "game_version": "string",
  "name": "string",
  "short_desc": "string",
  "ref_1": "string",
  "ref_2": "string",
  "ref_3": "string",
  "ref_4": "string",
  "ref_5": "string",
  "ref_6": "string",
  "ref_7": "string",
  "ref_8": "string",
  "ref_9": "string",
  "ref_10": "string",
  "ref_11": "string",
  "ref_12": "string",
  "ref_13": "string",
  "ref_14": "string",
  "ref_15": "string",
  "ref_16": "string",
  "ref_17": "string",
  "ref_18": "string",
  "ref_19": "string",
  "ref_20": "string",
  "ref_21": "string",
  "ref_22": "string",
  "ref_23": "string",
  "ref_24": "string",
  "ref_25": "string",
  "ref_26": "string",
  "ref_27": "string",
  "ref_28": "string",
  "ref_29": "string",
  "ref_30": "string",
  "ref_31": "string",
  "ref_32": "string",
  "content": "string",
  "sections": [
    {
      "section_type": "string",
      "name": "string",
      "short_desc": "string",
      "content": "string",
      "ref_1": "string",
      "ref_2": "string",
      "ref_3": "string",
      "ref_4": "string",
      "ref_5": "string",
      "ref_6": "string",
      "ref_7": "string",
      "ref_8": "string",
      "ref_9": "string",
      "ref_10": "string",
      "ref_11": "string",
      "ref_12": "string",
      "ref_13": "string",
      "ref_14": "string",
      "ref_15": "string",
      "ref_16": "string",
      "ref_17": "string",
      "ref_18": "string",
      "ref_19": "string",
      "ref_20": "string",
      "ref_21": "string",
      "ref_22": "string",
      "ref_23": "string",
      "ref_24": "string",
      "ref_25": "string",
      "ref_26": "string",
      "ref_27": "string",
      "ref_28": "string",
      "ref_29": "string",
      "ref_30": "string",
      "ref_31": "string",
      "ref_32": "string"
    }
  ]
}'
```

--------------------------------

### Remove Entity Favorite Guide via cURL

Source: https://docs.rallyhere.gg/environment-api-reference/remove-entity-favorite-guide

Example request using cURL to remove a guide from favorites.

```bash
curl -L -X DELETE 'https://demo.rally-here.io/guide/v1/:entity_type/:entity_id/favorite-guide/:guide_id' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-app-settings-server

Example command to fetch app settings using cURL.

```bash
curl -L 'https://demo.rally-here.io/config/v1/app_settings/server' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Successful Response Schema Example

Source: https://docs.rallyhere.gg/environment-api-reference/add-entity-favorite-guide

Example JSON response body returned upon successfully adding a guide to favorites.

```json
{
  "guide_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "favorited_at": "2023-01-23T21:07:02.000000+00:00"
}
```

--------------------------------

### Create Guide

Source: https://docs.rallyhere.gg/environment-api-reference/create-guide

Creates a new guide entity with the specified metadata, content, and sections.

```APIDOC
## POST /guides

### Description
Creates a new guide in the system.

### Method
POST

### Request Body
- **guide_type** (string) - Required - Guide Type (<= 16 characters)
- **language** (string) - Required - Language (<= 3 characters)
- **game_version** (string) - Required - Version this guide was created for (<= 64 characters)
- **name** (string) - Required - Name (non-empty, <= 128 characters)
- **short_desc** (string) - Optional - Short description (<= 512 characters)
- **owner_entity_type** (string) - Required - Entity type (must be 'player')
- **owner_entity_id** (string) - Required - Owner Entity Id (<= 128 characters)
- **content** (string) - Optional - Root content of the guide (<= 16384 characters)
- **sections** (array) - Optional - Array of sections (max 16)

### Response
#### Success Response (201)
- **guide_id** (uuid) - Unique identifier for the guide
- **created** (date-time) - Creation timestamp
- **modified** (date-time) - Last modified timestamp
- **favorites** (integer) - Number of favorites (default 0)
- **upvotes** (integer) - Number of upvotes (default 0)
- **downvotes** (integer) - Number of downvotes (default 0)
- **etag** (string) - Unique identifier for this version of the guide
```

--------------------------------

### Get Entity Favorite Guide Endpoint

Source: https://docs.rallyhere.gg/environment-api-reference/get-entity-favorite-guide

The base URL and method for retrieving favorite guides for a specified entity type and ID.

```http
GET 
## https://demo.rally-here.io/guide/v1/:entity_type/:entity_id/favorite-guide
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/developer-api-reference/overlay-get-environment-overlay-entries

A command-line example to retrieve overlay entries using the curl utility.

```bash
curl -L '/api/v1/product/:product_id/environment/:environment_id/overlay' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-player-uuid-key-claims

Example command to fetch player key claims using an authorization token.

```bash
curl -L 'https://demo.rally-here.io/inventory/v2/player/:player_uuid/keyClaim' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get Account Permissions Response Example

Source: https://docs.rallyhere.gg/developer-api-reference/get-all-account-permissions-for-account

Example of a successful 200 OK response body containing an array of account permission objects.

```json
[
  {
    "account_permission_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "assigned_org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "environment_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "permission_id": "string"
  }
]
```

--------------------------------

### GET /guide/v1/guide/:guide_id

Source: https://docs.rallyhere.gg/environment-api-reference/get-guide-by-id

Retrieves a specific guide by its unique ID.

```APIDOC
## GET /guide/v1/guide/:guide_id

### Description
Retrieves the details of a specific guide identified by the provided guide_id.

### Method
GET

### Endpoint
https://demo.rally-here.io/guide/v1/guide/:guide_id

### Parameters
#### Path Parameters
- **guide_id** (string) - Required - The unique identifier of the guide.

### Response
#### Success Response (200)
- **guide_type** (string) - Type of the guide
- **language** (string) - Language of the guide
- **game_version** (string) - Game version associated with the guide
- **name** (string) - Name of the guide
- **short_desc** (string) - Short description
- **guide_id** (string) - Unique ID of the guide
- **owner_entity_type** (string) - Type of the owner entity
- **owner_entity_id** (string) - ID of the owner entity
- **created** (string) - Creation timestamp
- **modified** (string) - Last modified timestamp
- **favorites** (integer) - Number of favorites
- **upvotes** (integer) - Number of upvotes
- **downvotes** (integer) - Number of downvotes
- **etag** (string) - ETag for caching
- **content** (string) - Main content of the guide
- **sections** (array) - List of guide sections

#### Response Example
{
  "guide_type": "string",
  "language": "string",
  "game_version": "string",
  "name": "string",
  "short_desc": "string",
  "guide_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "owner_entity_type": "player",
  "owner_entity_id": "string",
  "created": "2023-01-23T21:07:02.000000+00:00",
  "modified": "2023-01-23T21:07:02.000000+00:00",
  "favorites": 0,
  "upvotes": 0,
  "downvotes": 0,
  "etag": "string",
  "content": "string",
  "sections": []
}
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/developer-api-reference/get-game-config-versions

Example command to fetch game config versions using cURL.

```bash
curl -L '/api/v1/history/sandbox/:sandbox_id/game-config' \
-H 'Accept: application/json'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-catalog-all

Example command to fetch the catalog using a Bearer token for authentication.

```bash
curl -L 'https://demo.rally-here.io/inventory/v1/catalog' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### GET https://demo.rally-here.io/guide/v1/guide/:guide_id

Source: https://docs.rallyhere.gg/environment-api-reference/get-guide-by-id

Retrieves a guide by its unique ID.

```APIDOC
## GET https://demo.rally-here.io/guide/v1/guide/:guide_id

### Description
Get guide by ID. Requires permissions: guide:*, guide:read.

### Method
GET

### Endpoint
https://demo.rally-here.io/guide/v1/guide/:guide_id

### Parameters
#### Path Parameters
- **guide_id** (uuid) - Required - The unique identifier of the guide.

### Response
#### Success Response (200)
- **guide_type** (string) - Guide Type
- **language** (string) - Language
- **game_version** (string) - Version this guide was created for
- **name** (string) - Name of the guide
- **short_desc** (string) - Short description
- **ref_1** through **ref_32** (string) - Reference fields
- **guide_id** (uuid) - Guide ID
- **owner_entity_type** (string) - Owner entity type (e.g., player)
- **owner_entity_id** (string) - Owner entity ID
- **created** (date-time) - Creation timestamp
- **modified** (date-time) - Last modified timestamp
- **favorites** (integer) - Number of favorites
- **upvotes** (integer) - Number of upvotes
- **downvotes** (integer) - Number of downvotes
- **etag** (string) - Unique identifier for this version
- **content** (string) - Root content of the guide
- **sections** (array) - Array of guide sections
```

--------------------------------

### Create Environment via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/environment-create-environment

Example command to create an environment by sending a POST request to the product endpoint.

```bash
curl -L '/api/v1/product/:product_id/environment' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "string",
  "short_name": "string",
  "base_url": "string",
  "primary_contact_email": "string",
  "base_sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "archive": false,
  "state": "creating",
  "authentication_state": "open",
  "kick_before_hint": "2024-07-29T15:51:28.071Z",
  "classic_support_tool_url": "string",
  "usage": "dev",
  "sandbox_generation_enabled": false,
  "sandbox_generation_timestamp": "2024-07-29T15:51:28.071Z",
  "sandbox_generation_version": 0
}'
```

--------------------------------

### Get All Hosts Request

Source: https://docs.rallyhere.gg/developer-api-reference/get-all-hosts

Example cURL command to retrieve all hosts.

```bash
curl -L '/api/v1/armada/host' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/create-new-inventory-session-by-player-uuid

Example of how to initiate the request using cURL.

```bash
curl -L 'https://demo.rally-here.io/inventory/v2/player/:player_uuid/session' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "session_platform": "Anon"
}'
```

--------------------------------

### Retrieve Product via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/get-org-product

Example command to fetch product details using an authorization token.

```bash
curl -L '/api/v1/org/:org_identifier/product/:product_identifier' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### GET /guide/v1/:entity_type/:entity_id/favorite-guide

Source: https://docs.rallyhere.gg/environment-api-reference/get-entity-favorite-guide

Retrieves the favorite guides for a specified entity.

```APIDOC
## GET /guide/v1/:entity_type/:entity_id/favorite-guide

### Description
Get entity's favorite guides.

### Method
GET

### Endpoint
https://demo.rally-here.io/guide/v1/:entity_type/:entity_id/favorite-guide

### Parameters
#### Path Parameters
- **entity_type** (EntityType) - Required - Possible values: [player]
- **entity_id** (string) - Required

#### Query Parameters
- **sort_by** (SearchFavoriteGuideSort) - Optional - Possible values: [created, modified, upvotes, favorited_at]. Default: favorited_at
- **sort** (SortDirection) - Optional - Possible values: [asc, desc]. Default: desc
- **cursor** (any) - Optional
- **page_size** (integer) - Optional - Default: 20
- **owner_entity_type** (any) - Optional
- **owner_entity_id** (any) - Optional
- **language** (any) - Optional
- **guide_type** (any) - Optional
- **game_version** (any) - Optional
- **name** (any) - Optional
- **ref_1** through **ref_32** (any) - Optional

### Response
#### Success Response (200)
- Returns a list of favorite guides in application/json format.
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-app-settings-all

Example command to fetch settings using cURL with an authorization token.

```bash
curl -L 'https://demo.rally-here.io/config/v1/kv' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get All Maps CURL Request

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-all-maps

Example of how to call the endpoint using cURL.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/map' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### GET /guide/v1/:entity_type/:entity_id/favorite-guide

Source: https://docs.rallyhere.gg/environment-api-reference/get-entity-favorite-guide

Retrieves a list of favorite guides for a specified entity.

```APIDOC
## GET /guide/v1/:entity_type/:entity_id/favorite-guide

### Description
Retrieves a list of favorite guides for a specified entity. Supports filtering by various guide attributes and pagination.

### Method
GET

### Endpoint
/guide/v1/:entity_type/:entity_id/favorite-guide

### Parameters
#### Path Parameters
- **entity_type** (string) - Required - The type of the entity (e.g., player).
- **entity_id** (string) - Required - The unique identifier of the entity.

#### Query Parameters
- **sort_by** (string) - Optional - Field to sort by (created, modified, upvotes, favorited_at).
- **sort** (string) - Optional - Sort order (asc, desc).
- **cursor** (string) - Optional - Pagination cursor.
- **page_size** (integer) - Optional - Number of items per page.
- **owner_entity_type** (string) - Optional - Filter by owner entity type.
- **owner_entity_id** (string) - Optional - Filter by owner entity ID.
- **language** (string) - Optional - Filter by language.
- **guide_type** (string) - Optional - Filter by guide type.
- **game_version** (string) - Optional - Filter by game version.
- **name** (string) - Optional - Filter by name.
- **ref_1** through **ref_32** (string) - Optional - Filter by reference fields.

### Response
#### Success Response (200)
- **results** (array) - List of favorite guides.
- **cursor** (string) - Pagination cursor for the next page.

#### Response Example
{
  "results": [
    {
      "guide_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "owner_entity_type": "player",
      "owner_entity_id": "string",
      "created": "2023-01-23T21:07:02.000000+00:00",
      "modified": "2023-01-23T21:07:02.000000+00:00",
      "favorites": 0,
      "upvotes": 0,
      "downvotes": 0,
      "etag": "string"
    }
  ],
  "cursor": "string"
}
```

--------------------------------

### Create Instance Request cURL Example

Source: https://docs.rallyhere.gg/environment-api-reference/create-instance-request

Example cURL command to create an instance via the session API.

```bash
curl -L 'https://demo.rally-here.io/session/v1/session/:session_id/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "instance_id": "string",
  "instance_startup_params": {
    "map": "string",
    "mode": "string",
    "misc_params": "string",
    "custom_data": {}
  },
  "host_type": "dedicated",
  "instance_request_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "host_player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "custom_data": {}
}'
```

--------------------------------

### Create Partition via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-create-partition

Example command to create a crossplay partition using cURL.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/crossplay-partition' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "string",
  "description": "string",
  "custom_data": {},
  "enabled": true
}'
```

--------------------------------

### Get Schedule CURL Request

Source: https://docs.rallyhere.gg/developer-api-reference/schedule-get-schedule

Example command to retrieve a schedule using cURL.

```bash
curl -L '/api/v1/product/:product_id/schedule/:schedule_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-all-platform-session-templates

Example command to retrieve platform session templates using cURL.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/session-template/:session_template_id/platform-session-template' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get Stride CURL Request

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-stride

Example command to retrieve a MatchMakingStride using cURL.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/match-making-stride/:match_making_stride_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-catalog-portal-use-ruleset

Example command to retrieve a portal use ruleset using cURL.

```bash
curl -L 'https://demo.rally-here.io/inventory/v1/catalog/portal-use-ruleset/:portal_use_ruleset_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get Rank CURL Request

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-rank

Example command to retrieve a rank using CURL.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/rank/:rank_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get MatchMakingTemplateGroup via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-group

Example request using the cURL command-line tool.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/match-making-template-group/:match_making_template_group_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-all-player-id-settings-for-setting-type

Example command to retrieve player settings using cURL.

```bash
curl -L 'https://demo.rally-here.io/settings/v1/player/:player_id/setting_type/:setting_type_id/key' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get MatchMakingProfileListEntry CURL Request

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-entry

Example command to retrieve the entry using cURL.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/match-making-profile-list/:match_making_profile_list_id/match-making-profile-list-entry/:match_making_profile_list_entry_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/backfill-config

Example command to retrieve the backfill configuration using a bearer token.

```bash
curl -L 'https://demo.rally-here.io/session/v1/backfill/config' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Create Virtual Machine Operating System via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/create-virtual-machine-operating-system

Example request using cURL to create a virtual machine operating system.

```bash
curl -L '/api/v1/terraform/virtual_machine_operating_system' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "os_distribution": "string",
  "os_version": "string"
}'
```

--------------------------------

### POST /api/v1/armada/azure-import

Source: https://docs.rallyhere.gg/developer-api-reference/create-azure-import-job

Starts an Azure import job.

```APIDOC
## POST /api/v1/armada/azure-import

### Description
Starts an Azure import job.

### Method
POST

### Endpoint
/api/v1/armada/azure-import

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **body** (any) - Successful Response
```

--------------------------------

### Get Group via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/get-group-by-group-id

Example request using the cURL command-line tool.

```bash
curl -L '/api/v2/group/:group_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get All Orgs via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/get-all-orgs

Example request to retrieve all organizations using cURL.

```bash
curl -L '/api/v1/org' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-catalog-price-points-all

Example command to fetch price points using cURL.

```bash
curl -L 'https://demo.rally-here.io/inventory/v1/catalog/price-point' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get Notifications CURL Request

Source: https://docs.rallyhere.gg/environment-api-reference/player-get-notifications-page

Example command to retrieve player notifications using CURL.

```bash
curl -L 'https://demo.rally-here.io/notification/v1/player/:player_uuid/notification' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get Person CURL Request

Source: https://docs.rallyhere.gg/environment-api-reference/get-person

Example command to retrieve person information using cURL.

```bash
curl -L 'https://demo.rally-here.io/users/v1/person/:person_id/info' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Create Datacenter Provider via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/create-dp

Example command to create a datacenter provider using the cURL utility.

```bash
curl -L '/api/v1/armada/datacenter_provider' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "string"
}'
```

--------------------------------

### Get Partition via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-partition

Example request using cURL to retrieve partition details.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/crossplay-partition/:crossplay_partition_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get Map CURL Request

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-map

Example command to retrieve map details using CURL.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/map/:map_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/developer-api-reference/get-menu-data

Example command to fetch menu data using cURL.

```bash
curl -L '/api/v1/menu-data/:account_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get Sandbox Item Request

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-item-by-id

Example request to retrieve a sandbox item using cURL.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/item/:item_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### cURL Request Example

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-all-instance-request-templates

Example command to retrieve instance request templates using cURL.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/instance-request-template' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get Kv History via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-kv-history

Example request using the cURL command-line tool.

```bash
curl -L '/api/v1/history/sandbox/:sandbox_id/kv' \
-H 'Accept: application/json'
```

--------------------------------

### Create Environment Client via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/product-create-environment-client

Example command to create an environment client using cURL.

```bash
curl -L '/api/v1/environment-client' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "string",
  "policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "description": "string",
  "environment_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
```

--------------------------------

### Get Custom Endpoint cURL Request

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-custom-endpoint-for-sandbox-and-custom-endpoint-unique-id

Example cURL command to retrieve a custom endpoint.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/custom-endpoint/:custom_endpoint_unique_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Retrieve Products via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/get-org-products

Example command to fetch organization products using an authorization token.

```bash
curl -L '/api/v1/org/:org_identifier/product' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### cURL Request Example

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-price-point-versions

Example command to retrieve price point versions using cURL.

```bash
curl -L '/api/v1/history/sandbox/:sandbox_id/price-point' \
-H 'Accept: application/json'
```

--------------------------------

### Get All Strides CURL Request

Source: https://docs.rallyhere.gg/developer-api-reference/sandbox-get-all-strides

Example command to retrieve all matchmaking strides using CURL.

```bash
curl -L '/api/v1/sandbox/:sandbox_id/match-making-stride' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get Portal Permission via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/get-portal-permission-by-id

Example request using the cURL command-line tool.

```bash
curl -L '/api/v1/portal-permissions/:permission_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-player-inventory-uuid-self

Example command to fetch player inventory using cURL.

```bash
curl -L 'https://demo.rally-here.io/inventory/v2/player/me/inventory' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### CURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-player-inventory

Example command to fetch player inventory using cURL.

```bash
curl -L 'https://demo.rally-here.io/inventory/v1/player/:player_id/inventory' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get Organization via cURL

Source: https://docs.rallyhere.gg/developer-api-reference/get-org

Example request using cURL to fetch organization details.

```bash
curl -L '/api/v1/org/:org_identifier' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### Get Host cURL Request

Source: https://docs.rallyhere.gg/developer-api-reference/get-host

Example command to retrieve host information using cURL.

```bash
curl -L '/api/v1/armada/host/:host_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```

--------------------------------

### cURL Request Example

Source: https://docs.rallyhere.gg/environment-api-reference/get-marketing-campaigns

Example command to retrieve marketing campaigns using cURL with an authorization token.

```bash
curl -L 'https://demo.rally-here.io/inventory/v1/marketing/campaign' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
```
Tokens:
Raw