API / Profiles

API

Profiles

Save settings once and reuse them for every job.

A profile is a named set of settings for one tool. Use a profile when the same settings are used for many builds; pass settings directly on the job when they vary.

  • A reusable profile works with any binary.
  • A pinned profile has a binary_id and can only be used with that binary.

Each job keeps its own copy of the settings it ran with, so editing or deleting a profile never changes past jobs.

Create#

http
POST /api/v1/profiles
Content-Type: application/json
json
{
  "name": "release",
  "tool": "protect",
  "settings": { "function_timeout": 300 }
}
Field Required Description
name yes Up to 64 characters, unique in your organization.
tool no Defaults to protect. See Tool options.
settings no Any options you leave out take their default. Unknown options are rejected.
binary_id no Pins the profile to one binary.
targets no all (the default) or listed. See Choosing functions.
functions no Rules choosing functions by name. Defaults to none.

Response: 201 Created with the profile. settings comes back complete, with defaults filled in:

json
{
  "id": "01a19951-b1cd-7cb3-884a-6410f326081f",
  "name": "release",
  "tool": "protect",
  "schema_version": 1,
  "binary_id": null,
  "settings": {
    "function_timeout": 300,
    "on_function_error": "keep_original"
  },
  "targets": "all",
  "functions": [],
  "created_at": "2026-11-01T22:53:50Z",
  "updated_at": "2026-11-01T22:53:50Z"
}

A name that's already taken returns 409; an invalid setting returns 422 with a message naming the option.

List, get, update, delete#

Request Result
GET /api/v1/profiles {"profiles": [ … ]}
GET /api/v1/profiles/{id} The profile.
PUT /api/v1/profiles/{id} Replaces name, settings, binary_id, targets and functions. Omitted settings go back to their defaults, and omitted rules mean all functions. The tool can't be changed.
DELETE /api/v1/profiles/{id} 204 No Content.

Choosing functions#

By default a profile protects every function in the binary. To protect only some, or to leave some out, give it rules. Rules name functions rather than addresses, so a profile keeps working when you rebuild: addresses change with every build, names usually don't. Names come from the binary's symbol file (see Symbols and functions).

json
{
  "name": "crypto-only",
  "targets": "listed",
  "functions": [
    { "match": "Aes256*" },
    { "match": "*Crypto::*" },
    { "match": "?pre_c_initialization@@YAHXZ" },
    { "match": "Aes256Init", "protect": false }
  ]
}

targets is where selection starts:

targets Meaning
all Every function, except those rules exclude. The default.
listed Only the functions rules select.

Each rule has:

Field Description
match A function's name, or a pattern with *. See below.
rva Instead of match: an address in hex, such as "0x2390". Only right for one exact build, so use it in a profile pinned to that binary.
protect false excludes the functions the rule matches. Absent or true selects them.
settings Options for just these functions, over the profile's settings. Only options whose scope is function in tool options can be set here: protection, virtualize_strength and on_function_error.

Matching. A rule is compared with each function's decorated name, undecorated name and export name, and matches if any of them fits.

  • Without *, the rule matches one exact name. Sha256 matches Sha256 but not Sha256Final.
  • With *, it matches whole names, where * stands for any run of characters. Sha256* matches Sha256 and Sha256Final. Undecorated names include the return type and parameters, so to match a namespace use *Crypto::*.
  • Matching is case-sensitive. * is the only wildcard; ?, _ and everything else match themselves, so decorated MSVC names can be used as they are.

Order. Rules apply in order. When several match a function, the last one decides whether it is protected, and its settings override those of earlier rules. So {"match": "Aes256*"}, {"match": "Aes256Init", "protect": false} protects every Aes256 function except Aes256Init.

Settings. A function gets the profile's settings, then the settings of each rule that matches it in order, a later rule overriding only the options it sets. For example, to protect everything but leave the hot path recompiled without the virtual machine:

json
"functions": [
  { "match": "Render*", "settings": { "protection": "none" } },
  { "match": "RenderInit", "settings": { "on_function_error": "fail_job" } }
]

RenderInit gets both: protection: none from the first rule and fail_job from the second.

A profile can have up to 1,000 rules, each up to 512 characters.

On the profile page you can pick functions from any analysed binary, and see how many functions each rule matches in it.

Rules are applied when a job is submitted, against that job's binary; see Function rules.