No results found

API Documentation Browser

Note: To see the full API specification without logging in, you must edit the following setting in AMPConfig.conf:

Security.AllowAPIDiscoveryWithoutLogin=True

AMP API calls are performed by making a POST request to the endpoint for a given call. All requests must have the following header appended:

Accept: text/javascript or Accept: application/json

Parameters are passed in the form of a JSON blob containing all the parameters as an object (the parameters are fields within that object). This should be posted as a parameter in the POST body called "parameters"

To perform any API calls you must first call the Core/Login method which will return a session ID. The session id is passed as a 'Bearer' token in the 'Authorization' header.

Example

If you wished to modify the EnableVoiceChat setting in the ARMA3 module after logging in. You'd make an API call to the following endpoint:

http://localhost:8080/API/Core/SetConfig

And your POST body would be the following (where the SESSIONID was obtained by making a login call):

{"node":"Arma3Module.Arma3Settings.EnableVoiceChat","value":false, SESSIONID: "4202b4ca-1066-4d88-9302-b74bac50a95c"}

SDK and Tools

See the AMP Wiki for information on obtaining the full SDK and a developer licence to write your own AMP plugins and modules.

Check out ThePotatoKing on GitHub for a quick start to working with AMP's API! They are a community contributor who has created multiple ways to work with the API in different languages.

Returns:

Parameter Type Description Required
Key Value

Invocation

URL

POST /API//

Request Headers


            

Body Payload


            
            

Related Methods: