/
XPGEO REST API Key Permissions

XPGEO REST API Key Permissions

When using XPGEO REST, it must be able to authenticate with your enterprise instance. This can be done with an API Key as follows:

  1. Inside of your content click Create Item:

image-20260202-164658.png

  1. We want to create a developer credential

  2. image-20260202-164741.png

    Select API Key Credentials

  3. image-20260202-164817.png

    Expiration date and referrer are based on your preference and are optional

  4. image-20260202-164920.png

    For permissions we need the 4 listed below:

  5. image-20260202-165120.png
    image-20260202-165144.png

    Give your key a name and choose where it is stored

  6. image-20260202-165230.png

    You can then either generate the key immediate or view the item in contents first. Once you have your api key place it within the .env file inside your XPGEO rest distribution.