Интеграция

⭐ Подбор игроков

Каждый матчмейкер управляет собственным приватным API, отдельным от API Edgegap вашей организации.

106KB

Импортировать спецификацию API в Веб-клиент Scalar API или Swagger Editor для изучения деталей.

Swagger Web UI: развертывание вашего сервиса сгенерирует спецификацию OpenAPI и удобный веб-интерфейс. Откройте URL в браузере, чтобы просмотреть и протестировать все конечные точки API и изучить примеры полезных нагрузок.

🧭 Браузер серверов

Каждый матчмейкер управляет собственным приватным API, отдельным от API Edgegap вашей организации.

🗺️ Локации

List Cloud Locations

get

List all locations available for cloud deployment. Optionally specify an app version to remove locations with insufficient capacity to deploy at this time.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Query parameters

appstringOptional

Custom identifier.

Example: my-game-server

versionstringOptional

Custom version identifier, often a timestamp or a build ID.

Example: 2024.01.30-16.23.00-UTC

pageinteger · min: 1OptionalExample: 2

limitinteger · min: 1OptionalExample: 20

Header parameters

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Responses

200

Success

application/json

messagesstring[]Optional

Additional information regarding locations.

Example: [""]

total_countintegerRequiredExample: 100

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/v1/locations

GET /v1/locations HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "locations": [
    {
      "city": "Montreal",
      "country": "Canada",
      "continent": "North America",
      "administrative_division": "Quebec",
      "timezone": "Eastern Time",
      "latitude": 45.508888,
      "longitude": -73.561668
    }
  ],
  "messages": [
    ""
  ],
  "total_count": 100,
  "pagination": {
    "number": 1,
    "next_page_number": 2,
    "previous_page_number": 1,
    "paginator": {
      "num_pages": 10
    },
    "has_next": true,
    "has_previous": false
  }
}

🗼 Маяки

List Ping Beacons

get

List all active ping beacons.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Query parameters

pageinteger · min: 1OptionalExample: 2

limitinteger · min: 1OptionalExample: 20

Header parameters

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Responses

200

Success

application/json

countintegerRequired

Count of returned active ping beacons.

Example: 17

400Error

application/json

401Error

application/json

500

Internal Server Error

application/json

get/v1/locations/beacons

GET /v1/locations/beacons HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "locations": [
    {
      "host": "172.235.110.137",
      "fqdn": "b-51bfc6ad1864.pr.edgegap.net",
      "udp_port": 32167,
      "tcp_port": 32561,
      "location": {
        "city": "Montreal",
        "country": "Canada",
        "continent": "North America",
        "administrative_division": "Quebec",
        "timezone": "Eastern Time",
        "latitude": 45.508888,
        "longitude": -73.561668
      }
    }
  ],
  "count": 17
}

🗒️ Хранилище журналов

Create a New Endpoint Storage

post

Create an endpoint storage to store your container logs at the end of a deployment.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Header parameters

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Body

namestringRequired

Name of the Endpoint Storage

Example: my-s3-bucket

container_log_versionstring · enumOptional

v1 (default, legacy) stores 1 file per deployment. v2 (enhanced) streams chunks of logs in real time.

Default: v1Example: v2Possible values:

access_key_idstringRequired

Your access key ID to connect to your S3 Bucket.

Example: my-access-key-id

endpointstringRequired

Full URL to your S3 Bucket with https or http. It's recommended to not include your bucket name as a subdomain

Example: https://us-east-1.your-s3-provider.com

bucketstringRequired

Your secret access key to connect to your S3 Bucket. Will be encrypted.

Example: my-bucket

output_formatstring · enumOptional

The format how the logs will be exported to the bucket.

Default: TEXTExample: NDJSONPossible values:

secret_access_keystringRequired

Your secret access key to connect to your S3 Bucket. Will be encrypted.

Example: my-secret-access

Responses

200

Success

application/json

namestringRequired

Name of the Endpoint Storage

Example: my-s3-bucket

container_log_versionstring · enumOptional

v1 (default, legacy) stores 1 file per deployment. v2 (enhanced) streams chunks of logs in real time.

Default: v1Example: v2Possible values:

access_key_idstringRequired

Your access key ID to connect to your S3 Bucket.

Example: my-access-key-id

endpointstringRequired

Full URL to your S3 Bucket with https or http. It's recommended to not include your bucket name as a subdomain

Example: https://us-east-1.your-s3-provider.com

bucketstringRequired

Your secret access key to connect to your S3 Bucket. Will be encrypted.

Example: my-bucket

output_formatstring · enumOptional

The format how the logs will be exported to the bucket.

Default: TEXTExample: NDJSONPossible values:

create_timestringOptional

UTC time of endpoint creation

Example: 2022-01-01 00:00:00.000000

last_updatedstringOptional

UTC time of endpoint last update

Example: 2022-01-01 00:00:00.000000

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post/v1/storage/endpoint

POST /v1/storage/endpoint HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 224

{
  "name": "my-s3-bucket",
  "container_log_version": "v2",
  "access_key_id": "my-access-key-id",
  "endpoint": "https://us-east-1.your-s3-provider.com",
  "bucket": "my-bucket",
  "output_format": "NDJSON",
  "secret_access_key": "my-secret-access"
}

{
  "name": "my-s3-bucket",
  "container_log_version": "v2",
  "access_key_id": "my-access-key-id",
  "endpoint": "https://us-east-1.your-s3-provider.com",
  "bucket": "my-bucket",
  "output_format": "NDJSON",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Get an Endpoint Storage

get

Retrieve an endpoint storage. The secret_access_key won't be displayed.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Path parameters

endpoint_namestringRequired

Header parameters

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Responses

200

Success

application/json

namestringRequired

Name of the Endpoint Storage

Example: my-s3-endpoint

container_log_versionstring · enumOptional

v1 (default, legacy) stores 1 file per deployment. v2 (enhanced) streams chunks of logs in real time.

Default: v1Example: v2Possible values:

access_key_idstringRequired

Your access key ID to connect to your S3 Bucket.

Example: my-access-key-id

endpointstringRequired

Full URL to your S3 Bucket with https or http. It's recommended to not include your bucket name as a subdomain

Example: https://us-east-1.your-s3-provider.com

bucketstringRequired

Your secret access key to connect to your S3 Bucket. Will be encrypted.

Example: my-bucket

output_formatstring · enumOptional

The format how the logs will be exported to the bucket.

Default: TEXTExample: NDJSONPossible values:

create_timestringOptional

UTC time of endpoint storage creation

Example: 2022-01-01 00:00:00.000000

last_updatedstringOptional

UTC time of endpoint storage last update

Example: 2022-01-01 00:00:00.000000

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/v1/storage/endpoint/{endpoint_name}

GET /v1/storage/endpoint/{endpoint_name} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "name": "my-s3-endpoint",
  "container_log_version": "v2",
  "access_key_id": "my-access-key-id",
  "endpoint": "https://us-east-1.your-s3-provider.com",
  "bucket": "my-bucket",
  "output_format": "NDJSON",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

List All Endpoint Storage

get

List all endpoint storage.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Query parameters

pageinteger · min: 1OptionalExample: 2

limitinteger · min: 1OptionalExample: 20

Header parameters

X-Fieldsstring · maskOptional

An optional fields mask

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Responses

200

Success

application/json

paginationanyOptional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/v1/storage/endpoints

GET /v1/storage/endpoints HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "endpoints": [
    {
      "name": "my-s3-endpoint",
      "container_log_version": "v2",
      "access_key_id": "my-access-key-id",
      "endpoint": "https://us-east-1.your-s3-provider.com",
      "bucket": "my-bucket",
      "output_format": "NDJSON",
      "create_time": "2022-01-01 00:00:00.000000",
      "last_updated": "2022-01-01 00:00:00.000000"
    }
  ],
  "pagination": null
}

Update an Endpoint Storage

patch

Update an Endpoint Storage with new specifications.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Path parameters

endpoint_namestringRequired

Header parameters

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Body

namestringOptional

Name of the Endpoint Storage

Example: my-s3-endpoint

container_log_versionstring · enumOptional

v1 (default, legacy) stores 1 file per deployment. v2 (enhanced) streams chunks of logs in real time.

Default: v1Example: v2Possible values:

access_key_idstringOptional

Your access key ID to connect to your S3 Bucket.

Example: my-access-key-id

secret_access_keystringOptional

Your secret access key to connect to your S3 Bucket. Will be encrypted.

Example: my-secret-access

endpointstringOptional

Full URL to your S3 Bucket with https or http. It's recommended to not include your bucket name as a subdomain

Example: https://us-east-1.your-s3-provider.com

bucketstringOptional

Your secret access key to connect to your S3 Bucket. Will be encrypted.

Example: my-bucket

output_formatstring · enumOptional

The format how the logs will be exported to the bucket.

Default: TEXTExample: NDJSONPossible values:

Responses

200

Success

application/json

namestringOptional

Name of the Endpoint Storage

Example: my-s3-endpoint

container_log_versionstring · enumOptional

v1 (default, legacy) stores 1 file per deployment. v2 (enhanced) streams chunks of logs in real time.

Default: v1Example: v2Possible values:

access_key_idstringOptional

Your access key ID to connect to your S3 Bucket.

Example: my-access-key-id

endpointstringOptional

Full URL to your S3 Bucket with https or http. It's recommended to not include your bucket name as a subdomain

Example: https://us-east-1.your-s3-provider.com

bucketstringOptional

Your secret access key to connect to your S3 Bucket. Will be encrypted.

Example: my-bucket

output_formatstring · enumOptional

The format how the logs will be exported to the bucket.

Default: TEXTExample: NDJSONPossible values:

create_timestringOptional

UTC time of endpoint storage creation

Example: 2022-01-01 00:00:00.000000

last_updatedstringOptional

UTC time of endpoint storage last update

Example: 2022-01-01 00:00:00.000000

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

patch/v1/storage/endpoint/{endpoint_name}

PATCH /v1/storage/endpoint/{endpoint_name} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "name": "my-s3-endpoint",
  "container_log_version": "v2",
  "access_key_id": "my-access-key-id",
  "secret_access_key": "my-secret-access",
  "endpoint": "https://us-east-1.your-s3-provider.com",
  "bucket": "my-bucket",
  "output_format": "NDJSON"
}

{
  "name": "my-s3-endpoint",
  "container_log_version": "v2",
  "access_key_id": "my-access-key-id",
  "endpoint": "https://us-east-1.your-s3-provider.com",
  "bucket": "my-bucket",
  "output_format": "NDJSON",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Delete an Endpoint Storage

delete

Delete an endpoint storage. All the application versions linked to it won't be able to store logs anymore.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Path parameters

endpoint_namestringRequired

Header parameters

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Responses

204

No Content

No content

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete/v1/storage/endpoint/{endpoint_name}

DELETE /v1/storage/endpoint/{endpoint_name} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Create a New Pull Profile

post

Create a pull profile. Pull profile will upload data from an endpoint storage to a deployment container on boot. You must link the application version to the pull profile first.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Path parameters

endpoint_namestringRequired

Header parameters

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Body

namestringRequired

Name of the pull profile

Example: pull_profile_name

sourcestringRequired

Source in the S3 bucket to fetch from

Example: /my-bucket/config.cfg

source_typestring · enumRequired

If the source is a File or a Directory

Example: FilePossible values:

destinationstringRequired

Destination path where your source will be uploaded in your container. Make sure to avoid protected destinations, such as /etc/, as this will prevent the files from being copied to your deployment, and will make your deployment fail. Make sure a normal user can write to the destination folder.

Example: /usr/share/configs

Responses

200

Success

application/json

namestringRequired

Name of the pull profile

Example: pull_profile_name

sourcestringRequired

Source in the S3 bucket to fetch from

Example: /my-bucket/config.cfg

source_typestring · enumRequired

If the source is a File or a Directory

Example: FilePossible values:

destinationstringRequired

Example: /usr/share/configs

create_timestringOptional

UTC time of pull profile creation

Example: 2022-01-01 00:00:00.000000

last_updatedstringOptional

UTC time of pull profile last update

Example: 2022-01-01 00:00:00.000000

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/v1/storage/endpoint/{endpoint_name}/pull-profile

POST /v1/storage/endpoint/{endpoint_name}/pull-profile HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "name": "pull_profile_name",
  "source": "/my-bucket/config.cfg",
  "source_type": "File",
  "destination": "/usr/share/configs"
}

{
  "name": "pull_profile_name",
  "source": "/my-bucket/config.cfg",
  "source_type": "File",
  "destination": "/usr/share/configs",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Get a Pull Profile

get

Retrieve a pull profile and its specifications.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Path parameters

endpoint_namestringRequired

pull_profile_namestringRequired

Header parameters

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Responses

200

Success

application/json

namestringRequired

Name of the pull profile

Example: pull_profile_name

sourcestringRequired

Source in the S3 bucket to fetch from

Example: /my-bucket/config.cfg

source_typestring · enumRequired

If the source is a File or a Directory

Example: FilePossible values:

destinationstringRequired

Example: /usr/share/configs

create_timestringOptional

UTC time of pull profile creation

Example: 2022-01-01 00:00:00.000000

last_updatedstringOptional

UTC time of pull profile last update

Example: 2022-01-01 00:00:00.000000

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}

GET /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "name": "pull_profile_name",
  "source": "/my-bucket/config.cfg",
  "source_type": "File",
  "destination": "/usr/share/configs",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

List All Pull Profile of an Endpoint Storage

get

List all pull profiles of an endpoint storage.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Path parameters

endpoint_namestringRequired

Query parameters

pageinteger · min: 1OptionalExample: 2

limitinteger · min: 1OptionalExample: 20

Header parameters

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Responses

200

Success

application/json

total_countintegerRequiredExample: 100

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/v1/storage/endpoint/{endpoint_name}/pull-profiles

GET /v1/storage/endpoint/{endpoint_name}/pull-profiles HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "pull_profiles": [
    {
      "name": "pull_profile_name",
      "source": "/my-bucket/config.cfg",
      "source_type": "File",
      "destination": "/usr/share/configs",
      "create_time": "2022-01-01 00:00:00.000000",
      "last_updated": "2022-01-01 00:00:00.000000"
    }
  ],
  "total_count": 100,
  "pagination": {
    "number": 1,
    "next_page_number": 2,
    "previous_page_number": 1,
    "paginator": {
      "num_pages": 10
    },
    "has_next": true,
    "has_previous": false
  }
}

Link a Pull Profile to an Application Version

put

Link a pull profile to an app version. Without a link, the pull profile by itself will do nothing.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Path parameters

endpoint_namestringRequired

pull_profile_namestringRequired

app_namestringRequired

version_namestringRequired

Header parameters

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Responses

200

Success

application/json

appstringRequired

Name of the linked app of the linked version

Example: app_name

app_versionstringRequired

Name of the linked app version.

Example: version_name

endpointstringRequired

Name of the endpoint storage

Example: endpoint_name

pull_profilestringRequired

Name of the pull profile the app version is linked to.

Example: pull_profile_name

create_timestringOptional

UTC time of link creation

Example: 2022-01-01 00:00:00.000000

last_updatedstringOptional

UTC time of link last update

Example: 2022-01-01 00:00:00.000000

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

put/v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name}

PUT /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "app": "app_name",
  "app_version": "version_name",
  "endpoint": "endpoint_name",
  "pull_profile": "pull_profile_name",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Update a Pull Profile

patch

Update a pull profile with new specifications.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Path parameters

endpoint_namestringRequired

pull_profile_namestringRequired

Header parameters

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Body

anyOptional

Responses

200

Success

application/json

namestringOptional

Name of the pull profile

Example: pull_profile_name

sourcestringOptional

Source in the S3 bucket to fetch from

Example: /my-bucket/config.cfg

source_typestring · enumOptional

If the source is a File or a Directory

Example: FilePossible values:

destinationstringOptional

Example: /usr/share/configs

create_timestringOptional

UTC time of pull profile creation

Example: 2022-01-01 00:00:00.000000

last_updatedstringOptional

UTC time of pull profile last update

Example: 2022-01-01 00:00:00.000000

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

patch/v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}

PATCH /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*

{
  "name": "pull_profile_name",
  "source": "/my-bucket/config.cfg",
  "source_type": "File",
  "destination": "/usr/share/configs",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Unlink a Pull Profile From an Application Version

delete

Unlink a pull profile from an app version. It will not delete the pull profile.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Path parameters

endpoint_namestringRequired

pull_profile_namestringRequired

app_namestringRequired

version_namestringRequired

Header parameters

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Responses

204

Success

No content

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete/v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name}

DELETE /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Delete a Pull Profile

delete

Delete a pull profile. All the application versions linked won't receive the data upload anymore. It will not delete your endpoint storage.

Authorizations

AuthorizationstringRequired

Manage API tokens in dashboard.

Path parameters

endpoint_namestringRequired

pull_profile_namestringRequired

Header parameters

AcceptstringOptionalExample: */*

Content-TypestringOptionalExample: application/json

Responses

204

No Content

No content

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete/v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}

DELETE /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Accept: */*

No content

ПредыдущаяВерсионирование СледующаяРетрансляторы

Последнее обновление 2 месяца назад

Это было полезно?