Manage your fleet with Viam's fleet management API

package main

import (
    "context"
    "log"

    "go.viam.com/rdk/app"
    "go.viam.com/rdk/logging"
    "go.viam.com/utils"
)

func main() {
    logger := logging.NewLogger("fleet-management")
    
    // Replace "<API-KEY-ID>" (including brackets) with your API key ID
    apiKeyID := "<API-KEY-ID>"
    // Replace "<API-KEY>" (including brackets) with your API key
    apiKey := "<API-KEY>"
    
    client, err := app.NewAppClient(context.Background(), app.Config{
        BaseURL: "https://app.viam.com:443",
        Auth: utils.Credentials{
            Type:    utils.CredentialsTypeAPIKey,
            Payload: apiKey,
        },
        AuthEntity: &apiKeyID,
        Logger:     logger,
    })
    if err != nil {
        log.Fatalf("Failed to create app client: %v", err)
    }
    defer client.Close()
    
    // Use the client to make fleet management API calls
    // Example: List organizations
    ctx := context.Background()
    orgs, err := client.ListOrganizations(ctx)
    if err != nil {
        log.Fatalf("Failed to list organizations: %v", err)
    }
    
    for _, org := range orgs {
        log.Printf("Organization: %s (ID: %s)", org.Name, org.Id)
    }
}

async function connect(): Promise<VIAM.ViamClient> {
  // Replace "<API-KEY-ID>" (including brackets) with your machine's
  const API_KEY_ID = "<API-KEY-ID>";
  // Replace "<API-KEY>" (including brackets) with your machine's API key
  const API_KEY = "<API-KEY>";
  const opts: VIAM.ViamClientOptions = {
    serviceHost: "https://app.viam.com:443",
    credentials: {
      type: "api-key",
      authEntity: API_KEY_ID,
      payload: API_KEY,
    },
  };

  const client = await VIAM.createViamClient(opts);
  return client;
}

const viamClient = await connect();
const appClient = appClient.appClient;

Parameters:

• email (string) (required): The email of the user.

Returns:

• (string): The ID of the user.
• (error): An error, if one occurred.

Example:

userID, err := client.GetUserIDByEmail(ctx, "youremail@email.com")
if err != nil {
    log.Fatalf("Failed to get user ID: %v", err)
}
fmt.Printf("User ID: %s\n", userID)

For more information, see the Go SDK Docs.

Parameters:

• email (string) (required): The email address of the user.

Returns:

• (Promise): The user’s ID.

Example:

// This method is used internally only. To obtain a user's ID, use the listOrganizationsByUser method.
const members = await appClient.listOrganizationMembers(
  '<YOUR-ORGANIZATION-ID>'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• name (string) (required): The name of the organization.

Returns:

• (*app.Organization): The created organization.
• (error): An error, if one occurred.

Example:

organization, err := client.CreateOrganization(ctx, "name")
if err != nil {
    log.Fatalf("Failed to create organization: %v", err)
}
fmt.Printf("Created organization: %s\n", organization.Name)

For more information, see the Go SDK Docs.

Parameters:

• name (string) (required): The name of the new organization.

Returns:

• (Promise<undefined | Organization>): The new organization.

For more information, see the TypeScript SDK Docs.

Parameters:

• None.

Returns:

• ([]*app.Organization): The list of organizations.
• (error): An error, if one occurred.

Example:

orgList, err := client.ListOrganizations(ctx)
if err != nil {
    log.Fatalf("Failed to list organizations: %v", err)
}
for _, org := range orgList {
    fmt.Printf("Organization: %s (ID: %s)\n", org.Name, org.Id)
}

For more information, see the Go SDK Docs.

Parameters:

• None.

Returns:

• (Promise<Organization[]>): The organization list.

Example:

const organizations = await appClient.listOrganizations();

For more information, see the TypeScript SDK Docs.

Parameters:

• locationID (string) (required): The ID of the location.

Returns:

• ([]*app.OrganizationIdentity): The list of organizations.
• (error): An error, if one occurred.

Example:

orgList, err := client.GetOrganizationsWithAccessToLocation(ctx, "location-id")
if err != nil {
    log.Fatalf("Failed to get organizations with access to location: %v", err)
}
for _, org := range orgList {
    fmt.Printf("Organization: %s\n", org.Name)
}

For more information, see the Go SDK Docs.

Parameters:

• locationId (string) (required): The ID of the location to query.

Returns:

• (Promise<OrganizationIdentity[]>): The list of locations with access to the requested location.

Example:

const organizations =
  await appClient.getOrganizationsWithAccessToLocation(
    '<YOUR-LOCATION-ID>'
  );

For more information, see the TypeScript SDK Docs.

Parameters:

• userID (string) (required): The ID of the user. You can retrieve this with the GetUserIDByEmail() method.

Returns:

• ([]*app.OrgDetails): The list of organizations.
• (error): An error, if one occurred.

Example:

orgList, err := client.ListOrganizationsByUser(ctx, "<YOUR-USER-ID>")
if err != nil {
    log.Fatalf("Failed to list organizations by user: %v", err)
}
for _, org := range orgList {
    fmt.Printf("Organization: %s\n", org.OrgName)
}

For more information, see the Go SDK Docs.

Parameters:

• userId (string) (required): The ID of the user to query.

Returns:

• (Promise<OrgDetails[]>): The list of locations the requested user has access to.

For more information, see the TypeScript SDK Docs.

Parameters:

• orgID (string) (required): The ID of the organization to query. You can retrieve this from the organization settings page.

Returns:

• (*app.Organization): The requested organization.
• (error): An error, if one occurred.

Example:

org, err := client.GetOrganization(ctx, "<YOUR-ORG-ID>")
if err != nil {
    log.Fatalf("Failed to get organization: %v", err)
}
fmt.Printf("Organization: %s\n", org.Name)

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization.

Returns:

• (Promise<undefined | Organization>): Details about the organization, if it exists.

Example:

const organization = await appClient.getOrganization(
  '<YOUR-ORGANIZATION-ID>'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• publicNamespace (string) (required): Organization namespace to check. Namespaces can only contain lowercase alphanumeric and dash characters.

Returns:

• (bool): True if the provided namespace is available.
• (error): An error, if one occurred.

Example:

available, err := client.GetOrganizationNamespaceAvailability(ctx, "my-cool-organization")
if err != nil {
    log.Fatalf("Failed to check namespace availability: %v", err)
}
fmt.Printf("Namespace available: %t\n", available)

For more information, see the Go SDK Docs.

Parameters:

• namespace (string) (required): The namespace to query for availability.

Returns:

• (Promise): A boolean indicating whether or not the namespace is available.

Example:

const isAvailable =
  await appClient.getOrganizationNamespaceAvailability('name');

For more information, see the TypeScript SDK Docs.

Parameters:

• orgID (string) (required): The ID of the organization to update.
• name (*string) (optional): If provided, updates the org’s name.
• publicNamespace (*string) (optional): If provided, sets the org’s namespace if it hasn’t already been set.
• region (*string) (optional): If provided, updates the org’s region.
• cid (*string) (optional): If provided, updates the org’s CRM ID.

Returns:

• (*app.Organization): The updated organization.
• (error): An error, if one occurred.

Example:

name := "Artoo's Org"
publicNamespace := "artoo"
organization, err := client.UpdateOrganization(ctx, "<YOUR-ORG-ID>", &name, &publicNamespace, nil, nil)
if err != nil {
    log.Fatalf("Failed to update organization: %v", err)
}
fmt.Printf("Updated organization: %s\n", organization.Name)

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The id of the organization to update.
• name (string) (optional): Optional name to update the organization with.
• publicNamespace (string) (optional): Optional namespace to update the organization with.
• region (string) (optional): Optional region to update the organization with.
• cid (string) (optional): Optional CRM ID to update the organization with.

Returns:

• (Promise<undefined | Organization>): The updated organization details.

Example:

const organization = await appClient.updateOrganization(
  '<YOUR-ORGANIZATION-ID>',
  'newName'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• orgID (string) (required): The ID of the organization. You can obtain your organization ID from the Viam app’s organization settings page.

Returns:

• (error): An error, if one occurred.

Example:

err := client.DeleteOrganization(ctx, "<YOUR-ORG-ID>")
if err != nil {
    log.Fatalf("Failed to delete organization: %v", err)
}

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The id of the organization to delete.

Returns:

• (Promise)

Example:

await appClient.deleteOrganization('<YOUR-ORGANIZATION-ID>');

For more information, see the TypeScript SDK Docs.

Parameters:

• orgID (string) (required): The ID of the organization to list members of. You can obtain your organization ID from the Viam app’s organization settings page.

Returns:

• ([]*app.OrganizationMember): The list of organization members.
• ([]*app.OrganizationInvite): The list of organization invites.
• (error): An error, if one occurred.

Example:

memberList, inviteList, err := client.ListOrganizationMembers(ctx, "<YOUR-ORG-ID>")
if err != nil {
    log.Fatalf("Failed to list organization members: %v", err)
}
fmt.Printf("Found %d members and %d invites\n", len(memberList), len(inviteList))

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The id of the organization to query.

Returns:

• (Promise<ListOrganizationMembersResponse>): An object containing organization members, pending invites, and org ID.

Example:

const members = await appClient.listOrganizationMembers(
  '<YOUR-ORGANIZATION-ID>'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• orgID (string) (required): The ID of the organization to create an invite for. You can obtain your organization ID from the Viam app’s organization settings page.
• email (string) (required): The email address to send the invite to.
• authorizations ([]*app.Authorization) (optional): Specifications of the authorizations to include in the invite. If not provided, full owner permissions will be granted.
• sendEmailInvite (*bool) (optional): Whether or not an email should be sent to the recipient of an invite. Defaults to true.

Returns:

• (*app.OrganizationInvite): The organization invite.
• (error): An error, if one occurred.

Example:

invite, err := client.CreateOrganizationInvite(ctx, "<YOUR-ORG-ID>", "youremail@email.com", nil, nil)
if err != nil {
    log.Fatalf("Failed to create organization invite: %v", err)
}
fmt.Printf("Created invite for: %s\n", invite.Email)

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The id of the organization to create the invite for.
• email (string) (required): The email address of the user to generate an invite for.
• authorizations (Authorization) (required): The authorizations to associate with the new invite.
• sendEmailInvite (boolean) (optional): Bool of whether to send an email invite (true) or automatically add a user. Defaults to true.

Returns:

• (Promise<undefined | OrganizationInvite>): The organization invite.

Example:

const auth = new VIAM.appApi.Authorization({
  authorizationType: 'role',
  authorizationId: 'organization_operator',
  organizationId: '<YOUR-ORGANIZATION-ID>',
  resourceId: '<YOUR-RESOURCE-ID>', // The resource to grant access to
  resourceType: 'organization', // The type of resource to grant access to
  identityId: '<YOUR-USER-ID>', // The user id of the user to grant access to (optional)
  roleId: 'owner', // The role to grant access to
  identityType: 'user',
});

const invite = await appClient.createOrganizationInvite(
  '<YOUR-ORGANIZATION-ID>',
  'youremail@email.com',
  [auth]
);

For more information, see the TypeScript SDK Docs.

Parameters:

• locationID (string) (required): ID of the location to retrieve the machines from.

Returns:

• ([]*app.Robot): The list of robots.
• (error): An error, if one occurred.

Example:

listOfMachines, err := client.ListRobots(ctx, "123ab12345")
if err != nil {
    log.Fatalf("Failed to list robots: %v", err)
}
for _, robot := range listOfMachines {
    fmt.Printf("Robot: %s (ID: %s)\n", robot.Name, robot.Id)
}

For more information, see the Go SDK Docs.

Parameters:

• locId (string) (required): The ID of the location to list robots for.

Returns:

• (Promise<appApi.Robot[]>): The list of robot objects.

Example:

const robots = await appClient.listRobots('<YOUR-LOCATION-ID>');

For more information, see the TypeScript SDK Docs.

Parameters:

• name (string) (required): Name of the new machine.
• locationID (string) (required): ID of the location under which to create the machine.

Returns:

• (string): The new robot’s ID.
• (error): An error, if one occurred.

Example:

newMachineID, err := client.NewRobot(ctx, "beepboop", "my-location-id")
if err != nil {
    log.Fatalf("Failed to create new robot: %v", err)
}
fmt.Printf("Created new robot with ID: %s\n", newMachineID)

For more information, see the Go SDK Docs.

Parameters:

• locId (string) (required): The ID of the location to create the robot in.
• name (string) (required): The name of the new robot.

Returns:

• (Promise): The new robot’s ID.

Example:

const robotId = await appClient.newRobot(
  '<YOUR-LOCATION-ID>',
  'newRobot'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• robotID (string) (required): ID of the machine to get. You can copy this value from the URL of the machine’s page.

Returns:

• (*app.Robot): The machine.
• (error): An error, if one occurred.

Example:

machine, err := client.GetRobot(ctx, "1a123456-x1yz-0ab0-a12xyzabc")
if err != nil {
    log.Fatalf("Failed to get robot: %v", err)
}
fmt.Printf("Robot: %s\n", machine.Name)

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the robot.

Returns:

• (Promise<undefined | appApi.Robot>): The Robot object.

Example:

const robot = await appClient.getRobot('<YOUR-ROBOT-ID>');

For more information, see the TypeScript SDK Docs.

Parameters:

• orgID (string) (required): The ID of the organization to create the location under. You can obtain your organization ID from the Viam app’s organization settings page.
• name (string) (required): Name of the location.
• parentLocationID (*string) (optional): Optional parent location to put the location under. Defaults to a root-level location if no location ID is provided.

Returns:

• (*app.Location): The newly created location.
• (error): An error, if one occurred.

Example:

parentLocationID := "111ab12345"
myNewLocation, err := client.CreateLocation(ctx, "<YOUR-ORG-ID>", "Robotville", &parentLocationID)
if err != nil {
    log.Fatalf("Failed to create location: %v", err)
}
fmt.Printf("Created location: %s\n", myNewLocation.Name)

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization to create the location under.
• name (string) (required): The name of the location to create.
• parentLocationId (string) (optional): Optional name of a parent location to create the new location under.

Returns:

• (Promise<undefined | Location>): The location object.

Example:

const location = await appClient.createLocation(
  '<YOUR-ORGANIZATION-ID>',
  'name'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• orgID (string) (required): The ID of the org to list locations for. You can obtain your organization ID from the Viam app’s organization settings page.

Returns:

• ([]*app.Location): The list of locations.
• (error): An error, if one occurred.

Example:

locations, err := client.ListLocations(ctx, "<YOUR-ORG-ID>")
if err != nil {
    log.Fatalf("Failed to list locations: %v", err)
}
for _, location := range locations {
    fmt.Printf("Location: %s (ID: %s)\n", location.Name, location.Id)
});

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization to query.

Returns:

• (Promise<Location[]>): A list of locations under the organization.

Example:

const locations = await appClient.listLocations(
  '<YOUR-ORGANIZATION-ID>'

For more information, see the TypeScript SDK Docs.

Parameters:

• orgID (string) (required): The ID of the organization to create the key for. You can obtain your organization ID from the Viam app’s organization settings page.
• authorizations ([]*app.Authorization) (required): A list of authorizations to associate with the key.
• name (string) (optional): A name for the key. If empty, defaults to the current timestamp.

Returns:

• (string): The API key.
• (string): The API key ID.
• (error): An error, if one occurred.

Example:

auth := &app.Authorization{
    AuthorizationType: "role",
    AuthorizationId:   "owner",
    ResourceType:      "robot",
    ResourceId:        "your-machine-id123",
}

apiKey, apiKeyID, err := client.CreateKey(ctx, "<YOUR-ORG-ID>", []*app.Authorization{auth}, "my_key")
if err != nil {
    log.Fatalf("Failed to create key: %v", err)
}
fmt.Printf("Created API key: %s (ID: %s)\n", apiKey, apiKeyID)

For more information, see the Go SDK Docs.

Parameters:

• authorizations (Authorization) (required): The list of authorizations to provide for the API key.
• name (string) (optional): An optional name for the key. If none is passed, defaults to present timestamp.

Returns:

• (Promise<CreateKeyResponse>): The new key and ID.

For more information, see the TypeScript SDK Docs.

Parameters:

• orgID (string) (required): The ID of the organization to list API keys for. You can obtain your organization ID from the Viam app’s organization settings page.

Returns:

• ([]*app.APIKeyWithAuthorizations): The existing API keys and authorizations.
• (error): An error, if one occurred.

Example:

keys, err := client.ListKeys(ctx, "<YOUR-ORG-ID>")
if err != nil {
    log.Fatalf("Failed to list keys: %v", err)
}
for _, key := range keys {
    fmt.Printf("API Key: %s\n", key.ApiKey.Name)
}

For more information, see the Go SDK Docs.

Parameters:

• orgId (string) (required): The ID of the organization to query.

Returns:

• (Promise<APIKeyWithAuthorizations[]>): The list of API keys.

Example:

const keys = await appClient.listKeys('<YOUR-ORGANIZATION-ID>');

For more information, see the TypeScript SDK Docs.

Parameters:

• id (string) (required): The ID of the API key.

Returns:

• (error): An error, if one occurred.

Example:

err := client.DeleteKey(ctx, "key-id")
if err != nil {
    log.Fatalf("Failed to delete key: %v", err)
}

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the key to delete.

Returns:

• (Promise<DeleteKeyResponse>)

Example:

await appClient.deleteKey('<YOUR-KEY-ID>');

For more information, see the TypeScript SDK Docs.

Parameters:

• id (string) (required): The ID of the key to be rotated.

Returns:

• (string): The API key ID.
• (string): The API key.
• (error): An error, if one occurred.

Example:

keyID, key, err := client.RotateKey(ctx, "key-id")
if err != nil {
    log.Fatalf("Failed to rotate key: %v", err)
}
fmt.Printf("Rotated key: %s (ID: %s)\n", key, keyID)

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the key to rotate.

Returns:

• (Promise<RotateKeyResponse>): The updated key and ID.

Example:

const key = await appClient.rotateKey('<YOUR-KEY-ID>');

For more information, see the TypeScript SDK Docs.