Skip to main content

Class: ServerSecrets

A collection of server secrets defined in dedicated server configuration.

Example​

import { variables, secrets } from "@minecraft/server-admin";
import { http, HttpRequest, HttpRequestMethod, HttpHeader, HttpResponse } from "@minecraft/server-net";

const serverUrl = variables.get('serverEndpoint');

function getPlayerProfile(playerId: string): Promise<HttpResponse> {
    const req = new HttpRequest(serverUrl + 'getPlayerProfile');

    req.body = JSON.stringify({
        playerId,
    });

    const authTokenSec = secrets.get('authtoken');

    if (!authTokenSec) {
        throw new Error('authtoken secret not defined.');
    }

    req.method = HttpRequestMethod.Post;
    req.headers = [new HttpHeader('Content-Type', 'application/json'), new HttpHeader('auth', authTokenSec)];

    return http.request(req);
}

getPlayerProfile('dark navi');

Constructors​

new ServerSecrets()​

private new ServerSecrets(): ServerSecrets

Returns​

ServerSecrets

Properties​

names​

readonly names: string[]

Remarks​

A list of available, configured server secrets.

Methods​

get()​

get(name): SecretString

Parameters​

ParameterType
namestring

Returns​

SecretString

Remarks​

Returns a SecretString that is a placeholder for a secret configured in a JSON file. In certain objects, like an HttpHeader, this Secret is resolved at the time of execution but is not made available to the script environment.

This function can't be called in read-only mode.