The Codemagic connector lets your AI agent act in each user's Codemagic account. Each user connects their own Codemagic API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 31 · 19 · 1031 read19 write10 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Codemagic connection
In AgentKit > Connections, create a Codemagic connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'codemagic'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Codemagic:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'codemagic_apps_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "codemagic"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Codemagic:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="codemagic_apps_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Codemagic credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolcodemagic_app_caches_listList the build caches stored for a Codemagic application.Read-onlyList App Caches
List the build caches stored for a Codemagic application. Returns each cache's _id, workflowId, size in bytes and lastUsed time. Use this before Delete App Cache to find a cache ID.
Inputs
app_idstringrequired- Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
codemagic_app_getGet one Codemagic application by ID.Read-onlyGet App
Get one Codemagic application by ID. Returns the app's _id, appName, branches and Workflow Editor workflows (codemagic.yaml workflows are not listed). Use this after List Apps when you need an app's branches or workflow IDs.
Inputs
app_idstringrequired- Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
codemagic_app_tester_groups_listList the tester groups of a Codemagic application.Read-onlyList App Tester Groups
List the tester groups of a Codemagic application. Returns each group's ID and name. Tester groups receive app previews and builds. Use List Tester Group Contacts for members.
Inputs
app_idstringrequired- Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
pageinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of items per page. Example: 20.
codemagic_app_variable_groups_listList the environment variable groups defined for one Codemagic application.Read-onlyList App Variable Groups
List the environment variable groups defined for one Codemagic application. Returns the app's groups with ID and name. Use List Team Variable Groups for team-level groups.
Inputs
app_idstringrequired- Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
pageinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of items per page. Example: 20.
codemagic_app_workflows_listList the workflows of a Codemagic application.Read-onlyList App Workflows
List the workflows of a Codemagic application. Returns each workflow's ID and name. Use this to find a workflow ID for Start Build.
Inputs
app_idstringrequired- Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
codemagic_apps_listList every application added to Codemagic that the token's user can access.Read-onlyList Apps
List every application added to Codemagic that the token's user can access. Returns each app's _id, appName and Workflow Editor workflow IDs and names. Use this to find an app ID. Use Get App for one app's branches, or List Team Apps for one team with paging.
Inputs
This tool takes no inputs.
codemagic_build_actions_listList the actions (steps) of a Codemagic build.Read-onlyList Build Actions
List the actions (steps) of a Codemagic build. Returns a page of actions with name, status and timings. Use this to see which step of a build failed.
Inputs
build_idstringrequired- Codemagic build ID, as returned by Start Build or List Team Builds. Example: 5fabc6414c483700143f4f92.
pageinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of items per page. Example: 20.
codemagic_build_getGet one Codemagic build by ID.Read-onlyGet Build
Get one Codemagic build by ID. Returns status, app, workflow, branch or tag, commit, timings, build steps and artifacts with their download URLs. Use this to follow a build started with Start Build.
Inputs
build_idstringrequired- Codemagic build ID, as returned by Start Build or List Team Builds. Example: 5fabc6414c483700143f4f92.
codemagic_preview_getGet one Codemagic app preview by ID.Read-onlyGet App Preview
Get one Codemagic app preview by ID. Returns its status, device, build and access details. Use this after Start App Preview.
Inputs
preview_idstringrequired- App preview ID, from Start App Preview or List Team Previews. Example: 64f1c2a8b5d3e40012a1b2f6.
codemagic_team_allowed_email_domains_getGet the email domains allowed for a Codemagic team's external build notification recipients.Read-onlyGet Allowed Email Domains
Get the email domains allowed for a Codemagic team's external build notification recipients. Returns the list of allowed domains. Use Update Allowed Email Domains to change it.
Inputs
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
codemagic_team_apps_listList the applications in a Codemagic team, with paging and optional ID or name filters.Read-onlyList Team Apps
List the applications in a Codemagic team, with paging and optional ID or name filters. Returns a page of apps with each app's ID, name and repository. Use this for one team. Use List My Apps across all your teams.
Inputs
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
idarray- Only return apps with these app IDs. Example: ["5c9c064185dd2310123b8e96"].
namestring- Only return apps whose name contains this text. Example: my-app.
pageinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of items per page. Example: 20.
codemagic_team_build_analytics_getGet build analytics for a Codemagic team over a date range.Read-onlyGet Team Build Analytics
Get build analytics for a Codemagic team over a date range. Returns build counts, durations and outcomes for the period. Use this for trends. Use Get Team Build Summary for usage totals.
Inputs
period_fromstringrequired- Start of the period, as an ISO 8601 date. Example: 2026-01-01.
period_tostringrequired- End of the period, as an ISO 8601 date. Example: 2026-01-31.
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
codemagic_team_build_summary_getGet a build usage summary for a Codemagic team over a date range.Read-onlyGet Team Build Summary
Get a build usage summary for a Codemagic team over a date range. Returns totals such as build count and build minutes used for the period. Use this for usage totals. Use Get Team Build Analytics for detailed trends.
Inputs
period_fromstringrequired- Start of the period, as an ISO 8601 date. Example: 2026-01-01.
period_tostringrequired- End of the period, as an ISO 8601 date. Example: 2026-01-31.
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
codemagic_team_builds_by_status_getGet the number of builds per status in a Codemagic team over a date range.Read-onlyGet Team Builds By Status
Get the number of builds per status in a Codemagic team over a date range. Returns counts of finished, failed, canceled and other build statuses. Use this for a success-rate breakdown.
Inputs
period_fromstringrequired- Start of the period, as an ISO 8601 date. Example: 2026-01-01.
period_tostringrequired- End of the period, as an ISO 8601 date. Example: 2026-01-31.
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
app_idstring- Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
workflow_idstring- Only include builds of this workflow ID, from List App Workflows. Example: release.
codemagic_team_builds_listList builds in a Codemagic team, newest first, filtered by app, status, workflow, branch, tag or label.Read-onlyList Team Builds
List builds in a Codemagic team, newest first, filtered by app, status, workflow, branch, tag or label. Returns a page of builds with IDs, status, app, workflow, branch and timings, plus a cursor for the next page. Use this to find builds. Use Get Build for one build's full details and artifacts.
Inputs
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
app_idstring- Only return builds of this app ID. Example: 5c9c064185dd2310123b8e96.
branchstring- Only return builds of this branch. Example: main.
cursorstring- Cursor from the previous page's response, to fetch the next page. Example: eyJpZCI6IjY0ZjFjMmE4In0.
labelarray- Only return builds with these labels. Example: ["nightly"].
page_sizeinteger- Number of items per page. Example: 20.
statusstring- Only return builds in this status. Example: queued.one of
queuedwaitingbuildingfinishedfailedcanceledtimeoutskipped tagstring- Only return builds of this tag. Example: v1.0.0.
workflow_idstring- Only return builds of this workflow ID. Example: release.
codemagic_team_external_recipients_listList external email recipients registered for a Codemagic team's build notifications.Read-onlyList External Recipients
List external email recipients registered for a Codemagic team's build notifications. Returns a page of recipients with ID and email. Use this to find a recipient ID for Delete External Recipient.
Inputs
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
pageinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of items per page. Example: 20.
codemagic_team_getGet one Codemagic team by ID.Read-onlyGet Team
Get one Codemagic team by ID. Returns the team's ID, name and settings. Use List Teams to find the team ID.
Inputs
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
codemagic_team_invitations_listList pending invitations to a Codemagic team, optionally filtered by role, scope or app.Read-onlyList Team Invitations
List pending invitations to a Codemagic team, optionally filtered by role, scope or app. Returns a page of invitations with ID, email and roles. Use this to find an invitation ID for Revoke Team Invitation.
Inputs
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
app_idarray- Only return invitations with a role on any of these app IDs. Example: ["5c9c064185dd2310123b8e96"].
pageinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of items per page. Example: 20.
rolearray- Only return invitations with these roles: admin, member, app_developer or app_viewer. Example: ["member"].
scopestring- Only return invitations with this role scope, e.g. team or app. Example: team.one of
teamapp
codemagic_team_members_listList the members of a Codemagic team, optionally filtered by user, role, scope or app.Read-onlyList Team Members
List the members of a Codemagic team, optionally filtered by user, role, scope or app. Returns a page of members with user ID, name, email and roles. Use this to find a user ID for Update Team Membership or Remove Team Member.
Inputs
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
app_idarray- Only return team role holders and members with a grant on any of these app IDs. Example: ["5c9c064185dd2310123b8e96"].
idarray- Only return members with these user IDs. Example: ["5d85eaa0e941e00019e81bc2"].
pageinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of items per page. Example: 20.
rolearray- Only return members with these roles: owner, admin, member, app_developer or app_viewer. Example: ["admin"].
scopestring- Only return members whose role has this scope, e.g. team or app. Example: team.one of
teamapp
codemagic_team_previews_listList app previews in a Codemagic team.Read-onlyList Team App Previews
List app previews in a Codemagic team. Returns a page of previews with ID, build, status and timings. Use Get App Preview for one preview.
Inputs
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
pageinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of items per page. Example: 20.
codemagic_team_roles_listList the roles available in a Codemagic team.Read-onlyList Team Roles
List the roles available in a Codemagic team. Returns each role's name, scope and permissions. Use this before Update Team Membership or Create Team Invitation to pick valid roles.
Inputs
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
codemagic_team_variable_groups_listList the environment variable groups defined at Codemagic team level.Read-onlyList Team Variable Groups
List the environment variable groups defined at Codemagic team level. Returns a page of groups with ID, name and security settings. Use List App Variable Groups for app-level groups.
Inputs
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
pageinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of items per page. Example: 20.
codemagic_tester_group_contacts_listList the testers in a Codemagic tester group.Read-onlyList Tester Group Contacts
List the testers in a Codemagic tester group. Returns a page of contacts with ID and email. Use this to find a contact ID for Remove Tester Group Contact.
Inputs
tester_group_idstringrequired- Tester group ID, from List App Tester Groups. Example: 64f1c2a8b5d3e40012a1b2e5.
pageinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of items per page. Example: 20.
codemagic_tester_group_getGet one Codemagic tester group by ID.Read-onlyGet Tester Group
Get one Codemagic tester group by ID. Returns the group's ID, name and app. Use List Tester Group Contacts for its testers.
Inputs
tester_group_idstringrequired- Tester group ID, from List App Tester Groups. Example: 64f1c2a8b5d3e40012a1b2e5.
codemagic_user_apps_listList the applications the token's user can access, with paging and an optional name filter.Read-onlyList My Apps
List the applications the token's user can access, with paging and an optional name filter. Returns a page of apps with each app's ID, name and repository. Use this to find an app by name. Use List Team Apps for one team's apps.
Inputs
namestring- Only return apps whose name contains this text. Example: my-app.
pageinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of items per page. Example: 20.
codemagic_user_getGet the Codemagic user that owns the API token.Read-onlyGet Current User
Get the Codemagic user that owns the API token. Returns the user's ID, name, email and account details. Use this to check the token works and to find your user ID.
Inputs
This tool takes no inputs.
codemagic_user_team_permissions_getGet the permissions the token's user has in one Codemagic team.Read-onlyGet My Team Permissions
Get the permissions the token's user has in one Codemagic team. Returns the user's roles and permitted actions in that team. Use this to check access before calling team admin tools.
Inputs
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
codemagic_user_teams_listList the Codemagic teams the token's user belongs to.Read-onlyList Teams
List the Codemagic teams the token's user belongs to. Returns a page of teams with each team's ID and name. Use this to find a team ID for the team tools.
Inputs
pageinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of items per page. Example: 20.
codemagic_variable_group_getGet one Codemagic environment variable group by ID.Read-onlyGet Variable Group
Get one Codemagic environment variable group by ID. Returns the group's ID, name, owner and security settings. Use List Group Variables for the variables in it.
Inputs
variable_group_idstringrequired- Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
codemagic_variable_group_variable_getGet one variable in a Codemagic variable group.Read-onlyGet Group Variable
Get one variable in a Codemagic variable group. Returns the variable's ID, name, secure flag and value if it is not secure. Use List Group Variables to find the variable ID.
Inputs
variable_group_idstringrequired- Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
variable_idstringrequired- Variable ID, from List Group Variables. Example: 64f1c2a8b5d3e40012a1b2d4.
codemagic_variable_group_variables_listList the variables in a Codemagic variable group, optionally searched by name.Read-onlyList Group Variables
List the variables in a Codemagic variable group, optionally searched by name. Returns a page of variables with ID, name and whether each is secure; secure values are hidden. Use Get Group Variable for one variable.
Inputs
variable_group_idstringrequired- Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
pageinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of items per page. Example: 20.
searchstring- Only return variables whose name contains this text. Example: API_.
codemagic_app_createAdd a Git repository to Codemagic as a new application.WriteAdd App
Add a Git repository to Codemagic as a new application. Returns the new app's _id and appName. Use this for repositories Codemagic can already clone. Use Add App From Private Repository to supply an SSH key.
Inputs
repository_urlstringrequired- SSH or HTTPS URL used to clone the repository. Example: git@github.com:my-organization/my-repo.git.
team_idstring- Team ID to add the app directly to one of your teams; you must be an admin of that team. Omit to add it to your personal account. Example: 5fabc6414c483700143f4f11.
codemagic_app_create_from_private_repoAdd a private Git repository to Codemagic, using an SSH private key for cloning.WriteAdd App From Private Repository
Add a private Git repository to Codemagic, using an SSH private key for cloning. Returns the new application's _id and appName. Use this when Codemagic has no access to the repository. Use Add App when it can already clone it.
Inputs
repository_urlstringrequired- SSH or HTTPS URL used to clone the repository. Example: git@github.com:my-organization/my-repo.git.
ssh_keyobjectrequired- SSH key Codemagic uses to clone the repository: an object with data (the private key file, base64-encoded) and passphrase (the key's passphrase, or null if it has none). Example: {"data": "LS0tLS1CRUdJTiBPUEVOU1NIIFBSSVZBVEUgS0VZLS0tLS0K..", "passphrase": null}.
project_typestring- Set to flutter-app when adding a Flutter application; omit otherwise. Example: flutter-app.
team_idstring- Team ID to add the app to; you must be an admin of that team. Omit to add it to your personal account. Example: 5fabc6414c483700143f4f11.
codemagic_app_tester_group_createCreate a tester group for a Codemagic application.WriteCreate Tester Group
Create a tester group for a Codemagic application. Returns the new group's ID. Use Import Tester Group Contacts to add testers.
Inputs
app_idstringrequired- Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
namestringrequired- Name of the tester group. Example: QA team.
codemagic_app_variable_group_createCreate an environment variable group for one Codemagic application.WriteCreate App Variable Group
Create an environment variable group for one Codemagic application. Returns the new group's ID. Use Import Group Variables to add variables to it.
Inputs
app_idstringrequired- Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
namestringrequired- Name of the variable group, as referenced from codemagic.yaml. Example: staging_secrets.
codemagic_artifact_public_url_createCreate a time-limited public download URL for a build artifact.WriteCreate Artifact Public URL
Create a time-limited public download URL for a build artifact. Returns url (anyone with it can download the artifact) and expiresAt. Use this to share an artifact with someone outside Codemagic. Get the artifact path from Get Build.
Inputs
artifact_pathstringrequired- Path of the artifact after https://api.codemagic.io/artifacts/ in its authenticated download URL, from the build's artifacts in Get Build. Example: ef45fb91-4c89-4395-8f7d-9368b97490de/2dd0b3d6-ae58-4894-b470-8bc2b24e259a/myapp.ipa. Example: ef45fb91-4c89-4395-8f7d-9368b97490de/2dd0b3d6-ae58-4894-b470-8bc2b24e259a/myapp.ipa.
expires_atintegerrequired- When the public URL expires, as a UNIX timestamp in seconds. Example: 1767225600.
codemagic_build_cancelCancel a queued or running Codemagic build.WriteCancel Build
Cancel a queued or running Codemagic build. Returns an empty success response, or status 208 if the build had already finished. Use Get Build first to check the build is still running.
Inputs
build_idstringrequired- Codemagic build ID, as returned by Start Build or List Team Builds. Example: 5fabc6414c483700143f4f92.
codemagic_build_preview_startStart an in-browser app preview from a build artifact on a cloud device.WriteStart App Preview
Start an in-browser app preview from a build artifact on a cloud device. Returns the new preview with its ID and status. Use Get App Preview to follow it and Share App Preview to get a link. Can fail with 402 if the plan has no preview minutes.
Inputs
artifact_pathstringrequired- Path of the build artifact to run (an .apk or simulator .app build), from the build's artifacts in Get Build. Example: ef45fb91-4c89-4395-8f7d-9368b97490de/2dd0b3d6-ae58-4894-b470-8bc2b24e259a/myapp.apk.
build_idstringrequired- Codemagic build ID, as returned by Start Build or List Team Builds. Example: 5fabc6414c483700143f4f92.
codemagic_build_startStart a new build of a Codemagic app workflow on a branch or tag.WriteStart Build
Start a new build of a Codemagic app workflow on a branch or tag. Returns the new buildId. Use Get Build to follow its status. Branch and trigger settings in the workflow are ignored; the branch or tag you pass is built.
Inputs
app_idstringrequired- Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
workflow_idstringrequired- Workflow ID: the workflow key in codemagic.yaml, or the Workflow Editor workflow ID from Get App. Example: release.
branchstring- Git branch to build. Provide either branch or tag. Example: main.
environmentobject- Overrides for this build: variables (object of name to value), groups (array of variable group names) and softwareVersions (object such as xcode or flutter to version). Example: {"variables": {"API_URL": "https://staging.example.com"}, "groups": ["staging_secrets"], "softwareVersions": {"xcode": "15.4"}}.
instance_typestring- Build machine type, e.g. mac_mini_m2 or linux_x2. Example: mac_mini_m2.
labelsarray- Labels to add to the build, in addition to existing labels. Example: ["nightly"].
tagstring- Git tag to build. Provide either branch or tag. Example: v1.0.0.
codemagic_team_allowed_email_domains_updateReplace the email domains allowed for a Codemagic team's external build notification recipients.WriteUpdate Allowed Email Domains
Replace the email domains allowed for a Codemagic team's external build notification recipients. Returns the updated list of domains. The list you send replaces the current one. Requires team admin rights.
- Idempotent
Inputs
domainsarrayrequired- Complete list of allowed email domains; replaces the current list. Example: ["example.com"].
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
codemagic_team_external_recipients_addRegister external email addresses to receive a Codemagic team's build notifications.WriteAdd External Recipients
Register external email addresses to receive a Codemagic team's build notifications. Returns the registered recipients. Addresses must be in the team's allowed email domains; see Get Allowed Email Domains.
Inputs
emailsarrayrequired- Email addresses to register as notification recipients. Example: ["qa@example.com"].
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
codemagic_team_invitation_createInvite a person by email to join a Codemagic team with the given roles.WriteCreate Team Invitation
Invite a person by email to join a Codemagic team with the given roles. Returns the new invitation; Codemagic emails the invitee. Use List Team Roles for valid roles. Requires team admin rights.
Inputs
emailstringrequired- Email address of the person to invite. Example: dev@example.com.
rolesarrayrequired- Roles to give the invitee. A team role is {role: admin or member, scope: team}; an app role is {role: app_developer or app_viewer, scope: app, app_id}. Example: [{"role": "member", "scope": "team"}].
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
codemagic_team_membership_updateChange a member's roles in a Codemagic team.WriteUpdate Team Membership
Change a member's roles in a Codemagic team. Returns the updated membership. Use List Team Members to find the user ID and List Team Roles for valid roles. Requires team admin rights.
- Idempotent
Inputs
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
user_idstringrequired- Codemagic user ID of the team member, from List Team Members. Example: 5d85eaa0e941e00019e81bc2.
rolestring- Team-wide role to give the member: admin or member. Example: member.one of
adminmember rolesarray- Full list of roles to give the member. A team role is {role: admin or member, scope: team}; an app role is {role: app_developer or app_viewer, scope: app, app_id}. Example: [{"role": "member", "scope": "team"}].
codemagic_team_variable_group_createCreate an environment variable group at Codemagic team level.WriteCreate Team Variable Group
Create an environment variable group at Codemagic team level. Returns the new group's ID. Use Import Group Variables to add variables to it.
Inputs
advanced_securityobjectrequired- Which apps may use the group: enabled (true to restrict it) and selected_apps (app IDs allowed when enabled). Example: {"enabled": false, "selected_apps": []}.
namestringrequired- Name of the variable group, as referenced from codemagic.yaml. Example: staging_secrets.
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
codemagic_tester_group_contacts_importAdd testers to a Codemagic tester group by email.WriteImport Tester Group Contacts
Add testers to a Codemagic tester group by email. Returns the created contacts. May fail with 402 if the team's plan limits testers.
Inputs
emailsarrayrequired- Email addresses of the testers to add. Example: ["tester@example.com"].
tester_group_idstringrequired- Tester group ID, from List App Tester Groups. Example: 64f1c2a8b5d3e40012a1b2e5.
codemagic_tester_group_updateRename a Codemagic tester group.WriteRename Tester Group
Rename a Codemagic tester group. Returns an empty success response. Use List App Tester Groups to find the group ID.
Inputs
namestringrequired- New name for the tester group. Example: Beta testers.
tester_group_idstringrequired- Tester group ID, from List App Tester Groups. Example: 64f1c2a8b5d3e40012a1b2e5.
codemagic_variable_group_updateRename a Codemagic variable group or change which apps may use it.WriteUpdate Variable Group
Rename a Codemagic variable group or change which apps may use it. Returns an empty success response. Only the fields you send are changed.
Inputs
variable_group_idstringrequired- Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
advanced_securityobject- Which apps may use the group: enabled (true to restrict it) and selected_apps (app IDs allowed when enabled). Example: {"enabled": true, "selected_apps": ["5c9c064185dd2310123b8e96"]}.
namestring- New name for the group. Example: production_secrets.
codemagic_variable_group_variable_updateChange a variable's name, value or secure flag in a Codemagic variable group.WriteUpdate Group Variable
Change a variable's name, value or secure flag in a Codemagic variable group. Returns an empty success response. Only the fields you send are changed.
Inputs
variable_group_idstringrequired- Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
variable_idstringrequired- Variable ID, from List Group Variables. Example: 64f1c2a8b5d3e40012a1b2d4.
namestring- New variable name. Example: API_TOKEN.
secureboolean- Set true to store the value as a secret. Example: true.
valuestring- New variable value. Example: def456.
codemagic_variable_group_variables_importAdd one or more environment variables to a Codemagic variable group.WriteImport Group Variables
Add one or more environment variables to a Codemagic variable group. Returns the created variables. All variables in one call share the same secure setting.
Inputs
securebooleanrequired- Set true to store the values as secrets that are hidden after saving. Example: true.
variable_group_idstringrequired- Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
variablesarrayrequired- Variables to add, each with a name and a value. Example: [{"name": "API_TOKEN", "value": "abc123"}].
codemagic_app_cache_deleteDelete one stored build cache of a Codemagic application.DestructiveDelete App Cache
Delete one stored build cache of a Codemagic application. Returns the cache ID queued for deletion; deletion finishes asynchronously. Use List App Caches to find the cache ID. Use Delete All App Caches to clear every cache.
- Idempotent
Inputs
app_idstringrequired- Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
cache_idstringrequired- Cache ID, from List App Caches. Example: 620f9f218ab90da6b1b22e0e.
codemagic_app_caches_delete_allDelete every stored build cache of a Codemagic application.DestructiveDelete All App Caches
Delete every stored build cache of a Codemagic application. Returns the IDs of the caches queued for deletion; deletion finishes asynchronously. Use Delete App Cache to remove a single workflow's cache instead.
- Idempotent
Inputs
app_idstringrequired- Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
codemagic_preview_stopStop a running Codemagic app preview.DestructiveStop App Preview
Stop a running Codemagic app preview. Returns an empty success response. Use this to release the cloud device when testing is done.
- Idempotent
Inputs
preview_idstringrequired- App preview ID, from Start App Preview or List Team Previews. Example: 64f1c2a8b5d3e40012a1b2f6.
codemagic_team_external_recipient_deleteRemove an external email recipient from a Codemagic team's build notifications.DestructiveDelete External Recipient
Remove an external email recipient from a Codemagic team's build notifications. Returns an empty success response. Use List External Recipients to find the recipient ID.
- Idempotent
Inputs
recipient_idstringrequired- External recipient ID, from List External Recipients. Example: 64f1c2a8b5d3e40012a1b3b8.
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
codemagic_team_invitation_revokeRevoke a pending invitation to a Codemagic team.DestructiveRevoke Team Invitation
Revoke a pending invitation to a Codemagic team. Returns an empty success response; the invite link stops working. Use List Team Invitations to find the invitation ID.
- Idempotent
Inputs
invitation_idstringrequired- Invitation ID, from List Team Invitations. Example: 64f1c2a8b5d3e40012a1b3a7.
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
codemagic_team_member_removeRemove a user from a Codemagic team.DestructiveRemove Team Member
Remove a user from a Codemagic team. Returns an empty success response. Use List Team Members to find the user ID. Requires team admin rights.
- Idempotent
Inputs
team_idstringrequired- Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
user_idstringrequired- Codemagic user ID of the team member, from List Team Members. Example: 5d85eaa0e941e00019e81bc2.
codemagic_tester_group_contact_removeRemove one tester from a Codemagic tester group.DestructiveRemove Tester Group Contact
Remove one tester from a Codemagic tester group. Returns an empty success response. Use List Tester Group Contacts to find the contact ID.
- Idempotent
Inputs
contact_idstringrequired- Contact ID, from List Tester Group Contacts. Example: 64f1c2a8b5d3e40012a1b3c9.
tester_group_idstringrequired- Tester group ID, from List App Tester Groups. Example: 64f1c2a8b5d3e40012a1b2e5.
codemagic_tester_group_deleteDelete a Codemagic tester group and its contact list.DestructiveDelete Tester Group
Delete a Codemagic tester group and its contact list. Returns an empty success response. The testers stop receiving shares sent to this group.
- Idempotent
Inputs
tester_group_idstringrequired- Tester group ID, from List App Tester Groups. Example: 64f1c2a8b5d3e40012a1b2e5.
codemagic_variable_group_deleteDelete a Codemagic environment variable group and all variables in it.DestructiveDelete Variable Group
Delete a Codemagic environment variable group and all variables in it. Returns an empty success response. Builds that reference the group will no longer get its variables.
- Idempotent
Inputs
variable_group_idstringrequired- Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
codemagic_variable_group_variable_deleteDelete one variable from a Codemagic variable group.DestructiveDelete Group Variable
Delete one variable from a Codemagic variable group. Returns an empty success response. Use List Group Variables to find the variable ID.
- Idempotent
Inputs
variable_group_idstringrequired- Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
variable_idstringrequired- Variable ID, from List Group Variables. Example: 64f1c2a8b5d3e40012a1b2d4.
No tools match.