Home
/
API
/
Schemas

Schemas

Schemas

agentsdk.AWSInstanceIdentityToken

{
  "document": "string",
  "signature": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
documentstringtrue
signaturestringtrue

agentsdk.AuthenticateResponse

{
  "session_token": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
session_tokenstringfalse

agentsdk.AzureInstanceIdentityToken

{
  "encoding": "string",
  "signature": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
encodingstringtrue
signaturestringtrue

agentsdk.GitAuthResponse

{
  "password": "string",
  "url": "string",
  "username": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
passwordstringfalse
urlstringfalse
usernamestringfalse

agentsdk.GitSSHKey

{
  "private_key": "string",
  "public_key": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
private_keystringfalse
public_keystringfalse

agentsdk.GoogleInstanceIdentityToken

{
  "json_web_token": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
json_web_tokenstringtrue

agentsdk.Metadata

{
  "apps": [
    {
      "command": "string",
      "display_name": "string",
      "external": true,
      "health": "disabled",
      "healthcheck": {
        "interval": 0,
        "threshold": 0,
        "url": "string"
      },
      "icon": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "sharing_level": "owner",
      "slug": "string",
      "subdomain": true,
      "url": "string"
    }
  ],
  "derpmap": {
    "omitDefaultRegions": true,
    "regions": {
      "property1": {
        "avoid": true,
        "embeddedRelay": true,
        "nodes": [
          {
            "certName": "string",
            "derpport": 0,
            "forceHTTP": true,
            "hostName": "string",
            "insecureForTests": true,
            "ipv4": "string",
            "ipv6": "string",
            "name": "string",
            "regionID": 0,
            "stunonly": true,
            "stunport": 0,
            "stuntestIP": "string"
          }
        ],
        "regionCode": "string",
        "regionID": 0,
        "regionName": "string"
      },
      "property2": {
        "avoid": true,
        "embeddedRelay": true,
        "nodes": [
          {
            "certName": "string",
            "derpport": 0,
            "forceHTTP": true,
            "hostName": "string",
            "insecureForTests": true,
            "ipv4": "string",
            "ipv6": "string",
            "name": "string",
            "regionID": 0,
            "stunonly": true,
            "stunport": 0,
            "stuntestIP": "string"
          }
        ],
        "regionCode": "string",
        "regionID": 0,
        "regionName": "string"
      }
    }
  },
  "directory": "string",
  "environment_variables": {
    "property1": "string",
    "property2": "string"
  },
  "git_auth_configs": 0,
  "motd_file": "string",
  "startup_script": "string",
  "startup_script_timeout": 0,
  "vscode_port_proxy_uri": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
appsarray of codersdk.WorkspaceAppfalse
derpmaptailcfg.DERPMapfalse
directorystringfalse
environment_variablesobjectfalse
» [any property]stringfalse
git_auth_configsintegerfalseGit auth configs stores the number of Git configurations the Coder deployment has. If this number is >0, we set up special configuration in the workspace.
motd_filestringfalse
startup_scriptstringfalse
startup_script_timeoutintegerfalse
vscode_port_proxy_uristringfalse

agentsdk.PostAppHealthsRequest

{
  "healths": {
    "property1": "disabled",
    "property2": "disabled"
  }
}

Properties

NameTypeRequiredRestrictionsDescription
healthsobjectfalseHealths is a map of the workspace app name and the health of the app.
» [any property]codersdk.WorkspaceAppHealthfalse

agentsdk.PostLifecycleRequest

{
  "state": "created"
}

Properties

NameTypeRequiredRestrictionsDescription
statecodersdk.WorkspaceAgentLifecyclefalse

agentsdk.PostVersionRequest

{
  "version": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
versionstringfalse

agentsdk.Stats

{
  "conns_by_proto": {
    "property1": 0,
    "property2": 0
  },
  "num_comms": 0,
  "rx_bytes": 0,
  "rx_packets": 0,
  "tx_bytes": 0,
  "tx_packets": 0
}

Properties

NameTypeRequiredRestrictionsDescription
conns_by_protoobjectfalseConns by proto is a count of connections by protocol.
» [any property]integerfalse
num_commsintegerfalseNum comms is the number of connections received by an agent.
rx_bytesintegerfalseRx bytes is the number of received bytes.
rx_packetsintegerfalseRx packets is the number of received packets.
tx_bytesintegerfalseTx bytes is the number of transmitted bytes.
tx_packetsintegerfalseTx packets is the number of transmitted bytes.

agentsdk.StatsResponse

{
  "report_interval": 0
}

Properties

NameTypeRequiredRestrictionsDescription
report_intervalintegerfalseReport interval is the duration after which the agent should send stats again.

coderd.SCIMUser

{
  "active": true,
  "emails": [
    {
      "display": "string",
      "primary": true,
      "type": "string",
      "value": "[email protected]"
    }
  ],
  "groups": [null],
  "id": "string",
  "meta": {
    "resourceType": "string"
  },
  "name": {
    "familyName": "string",
    "givenName": "string"
  },
  "schemas": ["string"],
  "userName": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
activebooleanfalse
emailsarray of objectfalse
» displaystringfalse
» primarybooleanfalse
» typestringfalse
» valuestringfalse
groupsarray of undefinedfalse
idstringfalse
metaobjectfalse
» resourceTypestringfalse
nameobjectfalse
» familyNamestringfalse
» givenNamestringfalse
schemasarray of stringfalse
userNamestringfalse

coderd.cspViolation

{
  "csp-report": {}
}

Properties

NameTypeRequiredRestrictionsDescription
csp-reportobjectfalse

codersdk.APIKey

{
  "created_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "id": "string",
  "last_used": "2019-08-24T14:15:22Z",
  "lifetime_seconds": 0,
  "login_type": "password",
  "scope": "all",
  "updated_at": "2019-08-24T14:15:22Z",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringtrue
expires_atstringtrue
idstringtrue
last_usedstringtrue
lifetime_secondsintegertrue
login_typecodersdk.LoginTypetrue
scopecodersdk.APIKeyScopetrue
updated_atstringtrue
user_idstringtrue

Enumerated Values

PropertyValue
login_typepassword
login_typegithub
login_typeoidc
login_typetoken
scopeall
scopeapplication_connect

codersdk.APIKeyScope

"all"

Properties

Enumerated Values

Value
all
application_connect

codersdk.AddLicenseRequest

{
  "license": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
licensestringtrue

codersdk.AppHostResponse

{
  "host": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
hoststringfalseHost is the externally accessible URL for the Coder instance.

codersdk.AppearanceConfig

{
  "logo_url": "string",
  "service_banner": {
    "background_color": "string",
    "enabled": true,
    "message": "string"
  }
}

Properties

NameTypeRequiredRestrictionsDescription
logo_urlstringfalse
service_bannercodersdk.ServiceBannerConfigfalse

codersdk.AssignableRoles

{
  "assignable": true,
  "display_name": "string",
  "name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
assignablebooleanfalse
display_namestringfalse
namestringfalse

codersdk.AuditAction

"create"

Properties

Enumerated Values

Value
create
write
delete
start
stop

codersdk.AuditDiff

{
  "property1": {
    "new": null,
    "old": null,
    "secret": true
  },
  "property2": {
    "new": null,
    "old": null,
    "secret": true
  }
}

Properties

NameTypeRequiredRestrictionsDescription
[any property]codersdk.AuditDiffFieldfalse

codersdk.AuditDiffField

{
  "new": null,
  "old": null,
  "secret": true
}

Properties

NameTypeRequiredRestrictionsDescription
newanyfalse
oldanyfalse
secretbooleanfalse

codersdk.AuditLog

{
  "action": "create",
  "additional_fields": [0],
  "description": "string",
  "diff": {
    "property1": {
      "new": null,
      "old": null,
      "secret": true
    },
    "property2": {
      "new": null,
      "old": null,
      "secret": true
    }
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "ip": "string",
  "is_deleted": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
  "resource_icon": "string",
  "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
  "resource_link": "string",
  "resource_target": "string",
  "resource_type": "template",
  "status_code": 0,
  "time": "2019-08-24T14:15:22Z",
  "user": {
    "avatar_url": "http://example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "email": "[email protected]",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "last_seen_at": "2019-08-24T14:15:22Z",
    "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
    "roles": [
      {
        "display_name": "string",
        "name": "string"
      }
    ],
    "status": "active",
    "username": "string"
  },
  "user_agent": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
actioncodersdk.AuditActionfalse
additional_fieldsarray of integerfalse
descriptionstringfalse
diffcodersdk.AuditDifffalse
idstringfalse
ipstringfalse
is_deletedbooleanfalse
organization_idstringfalse
request_idstringfalse
resource_iconstringfalse
resource_idstringfalse
resource_linkstringfalse
resource_targetstringfalseResource target is the name of the resource.
resource_typecodersdk.ResourceTypefalse
status_codeintegerfalse
timestringfalse
usercodersdk.Userfalse
user_agentstringfalse

codersdk.AuditLogResponse

{
  "audit_logs": [
    {
      "action": "create",
      "additional_fields": [0],
      "description": "string",
      "diff": {
        "property1": {
          "new": null,
          "old": null,
          "secret": true
        },
        "property2": {
          "new": null,
          "old": null,
          "secret": true
        }
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "ip": "string",
      "is_deleted": true,
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
      "resource_icon": "string",
      "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
      "resource_link": "string",
      "resource_target": "string",
      "resource_type": "template",
      "status_code": 0,
      "time": "2019-08-24T14:15:22Z",
      "user": {
        "avatar_url": "http://example.com",
        "created_at": "2019-08-24T14:15:22Z",
        "email": "[email protected]",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "last_seen_at": "2019-08-24T14:15:22Z",
        "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
        "roles": [
          {
            "display_name": "string",
            "name": "string"
          }
        ],
        "status": "active",
        "username": "string"
      },
      "user_agent": "string"
    }
  ],
  "count": 0
}

Properties

NameTypeRequiredRestrictionsDescription
audit_logsarray of codersdk.AuditLogfalse
countintegerfalse

codersdk.AuthMethod

{
  "enabled": true
}

Properties

NameTypeRequiredRestrictionsDescription
enabledbooleanfalse

codersdk.AuthMethods

{
  "github": {
    "enabled": true
  },
  "oidc": {
    "enabled": true,
    "iconUrl": "string",
    "signInText": "string"
  },
  "password": {
    "enabled": true
  }
}

Properties

NameTypeRequiredRestrictionsDescription
githubcodersdk.AuthMethodfalse
oidccodersdk.OIDCAuthMethodfalse
passwordcodersdk.AuthMethodfalse

codersdk.AuthorizationCheck

{
  "action": "create",
  "object": {
    "organization_id": "string",
    "owner_id": "string",
    "resource_id": "string",
    "resource_type": "string"
  }
}

AuthorizationCheck is used to check if the currently authenticated user (or the specified user) can do a given action to a given set of objects.

Properties

NameTypeRequiredRestrictionsDescription
actionstringfalse
objectcodersdk.AuthorizationObjectfalseObject can represent a "set" of objects, such as: all workspaces in an organization, all workspaces owned by me, and all workspaces across the entire product. When defining an object, use the most specific language when possible to produce the smallest set. Meaning to set as many fields on 'Object' as you can. Example, if you want to check if you can update all workspaces owned by 'me', try to also add an 'OrganizationID' to the settings. Omitting the 'OrganizationID' could produce the incorrect value, as workspaces have both user and organization owners.

Enumerated Values

PropertyValue
actioncreate
actionread
actionupdate
actiondelete

codersdk.AuthorizationObject

{
  "organization_id": "string",
  "owner_id": "string",
  "resource_id": "string",
  "resource_type": "string"
}

AuthorizationObject can represent a "set" of objects, such as: all workspaces in an organization, all workspaces owned by me, all workspaces across the entire product.

Properties

NameTypeRequiredRestrictionsDescription
organization_idstringfalseOrganization ID (optional) adds the set constraint to all resources owned by a given organization.
owner_idstringfalseOwner ID (optional) adds the set constraint to all resources owned by a given user.
resource_idstringfalseResource ID (optional) reduces the set to a singular resource. This assigns a resource ID to the resource type, eg: a single workspace. The rbac library will not fetch the resource from the database, so if you are using this option, you should also set the owner ID and organization ID if possible. Be as specific as possible using all the fields relevant.
resource_typestringfalseResource type is the name of the resource. ./coderd/rbac/object.go has the list of valid resource types.

codersdk.AuthorizationRequest

{
  "checks": {
    "property1": {
      "action": "create",
      "object": {
        "organization_id": "string",
        "owner_id": "string",
        "resource_id": "string",
        "resource_type": "string"
      }
    },
    "property2": {
      "action": "create",
      "object": {
        "organization_id": "string",
        "owner_id": "string",
        "resource_id": "string",
        "resource_type": "string"
      }
    }
  }
}

Properties

NameTypeRequiredRestrictionsDescription
checksobjectfalseChecks is a map keyed with an arbitrary string to a permission check. The key can be any string that is helpful to the caller, and allows multiple permission checks to be run in a single request. The key ensures that each permission check has the same key in the response.
» [any property]codersdk.AuthorizationCheckfalseIt is used to check if the currently authenticated user (or the specified user) can do a given action to a given set of objects.

codersdk.AuthorizationResponse

{
  "property1": true,
  "property2": true
}

Properties

NameTypeRequiredRestrictionsDescription
[any property]booleanfalse

codersdk.BuildInfoResponse

{
  "external_url": "string",
  "version": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
external_urlstringfalseExternal URL references the current Coder version. For production builds, this will link directly to a release. For development builds, this will link to a commit.
versionstringfalseVersion returns the semantic version of the build.

codersdk.BuildReason

"initiator"

Properties

Enumerated Values

Value
initiator
autostart
autostop

codersdk.CreateFirstUserRequest

{
  "email": "string",
  "password": "string",
  "trial": true,
  "username": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
emailstringtrue
passwordstringtrue
trialbooleanfalse
usernamestringtrue

codersdk.CreateFirstUserResponse

{
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Properties

NameTypeRequiredRestrictionsDescription
organization_idstringfalse
user_idstringfalse

codersdk.CreateGroupRequest

{
  "avatar_url": "string",
  "name": "string",
  "quota_allowance": 0
}

Properties

NameTypeRequiredRestrictionsDescription
avatar_urlstringfalse
namestringfalse
quota_allowanceintegerfalse

codersdk.CreateOrganizationRequest

{
  "name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
namestringtrue

codersdk.CreateParameterRequest

{
  "copy_from_parameter": "000e07d6-021d-446c-be14-48a9c20bca0b",
  "destination_scheme": "none",
  "name": "string",
  "source_scheme": "none",
  "source_value": "string"
}

CreateParameterRequest is a structure used to create a new parameter value for a scope.

Properties

NameTypeRequiredRestrictionsDescription
copy_from_parameterstringfalseCopy from parameter allows copying the value of another parameter. The other param must be related to the same template_id for this to succeed. No other fields are required if using this, as all fields will be copied from the other parameter.
destination_schemecodersdk.ParameterDestinationSchemetrue
namestringtrue
source_schemecodersdk.ParameterSourceSchemetrue
source_valuestringtrue

Enumerated Values

PropertyValue
destination_schemenone
destination_schemeenvironment_variable
destination_schemeprovisioner_variable
source_schemenone
source_schemedata

codersdk.CreateTemplateRequest

{
  "allow_user_cancel_workspace_jobs": true,
  "default_ttl_ms": 0,
  "description": "string",
  "display_name": "string",
  "icon": "string",
  "name": "string",
  "parameter_values": [
    {
      "copy_from_parameter": "000e07d6-021d-446c-be14-48a9c20bca0b",
      "destination_scheme": "none",
      "name": "string",
      "source_scheme": "none",
      "source_value": "string"
    }
  ],
  "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1"
}

Properties

NameTypeRequiredRestrictionsDescription
allow_user_cancel_workspace_jobsbooleanfalseAllow users to cancel in-progress workspace jobs. *bool as the default value is "true".
default_ttl_msintegerfalseDefault ttl ms allows optionally specifying the default TTL for all workspaces created from this template.
descriptionstringfalseDescription is a description of what the template contains. It must be less than 128 bytes.
display_namestringfalseDisplay name is the displayed name of the template.
iconstringfalseIcon is a relative path or external URL that specifies an icon to be displayed in the dashboard.
namestringtrueName is the name of the template.
parameter_valuesarray of codersdk.CreateParameterRequestfalseParameter values is a structure used to create a new parameter value for a scope.]
template_version_idstringtrueTemplate version ID is an in-progress or completed job to use as an initial version of the template.
This is required on creation to enable a user-flow of validating a template works. There is no reason the data-model cannot support empty templates, but it doesn't make sense for users.

codersdk.CreateTemplateVersionDryRunRequest

{
  "parameter_values": [
    {
      "copy_from_parameter": "000e07d6-021d-446c-be14-48a9c20bca0b",
      "destination_scheme": "none",
      "name": "string",
      "source_scheme": "none",
      "source_value": "string"
    }
  ],
  "rich_parameter_values": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "workspace_name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
parameter_valuesarray of codersdk.CreateParameterRequestfalseParameter values is a structure used to create a new parameter value for a scope.]
rich_parameter_valuesarray of codersdk.WorkspaceBuildParameterfalse
workspace_namestringfalse

codersdk.CreateTestAuditLogRequest

{
  "action": "create",
  "additional_fields": [0],
  "build_reason": "autostart",
  "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
  "resource_type": "template",
  "time": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequiredRestrictionsDescription
actioncodersdk.AuditActionfalse
additional_fieldsarray of integerfalse
build_reasoncodersdk.BuildReasonfalse
resource_idstringfalse
resource_typecodersdk.ResourceTypefalse
timestringfalse

Enumerated Values

PropertyValue
actioncreate
actionwrite
actiondelete
actionstart
actionstop
build_reasonautostart
build_reasonautostop
build_reasoninitiator
resource_typetemplate
resource_typetemplate_version
resource_typeuser
resource_typeworkspace
resource_typeworkspace_build
resource_typegit_ssh_key
resource_typeauditable_group

codersdk.CreateTokenRequest

{
  "lifetime": 0,
  "scope": "all"
}

Properties

NameTypeRequiredRestrictionsDescription
lifetimeintegerfalse
scopecodersdk.APIKeyScopefalse

Enumerated Values

PropertyValue
scopeall
scopeapplication_connect

codersdk.CreateUserRequest

{
  "email": "[email protected]",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "password": "string",
  "username": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
emailstringtrue
organization_idstringtrue
passwordstringtrue
usernamestringtrue

codersdk.CreateWorkspaceBuildRequest

{
  "dry_run": true,
  "orphan": true,
  "parameter_values": [
    {
      "copy_from_parameter": "000e07d6-021d-446c-be14-48a9c20bca0b",
      "destination_scheme": "none",
      "name": "string",
      "source_scheme": "none",
      "source_value": "string"
    }
  ],
  "rich_parameter_values": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "state": [0],
  "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
  "transition": "create"
}

Properties

NameTypeRequiredRestrictionsDescription
dry_runbooleanfalse
orphanbooleanfalseOrphan may be set for the Destroy transition.
parameter_valuesarray of codersdk.CreateParameterRequestfalseParameter values are optional. It will write params to the 'workspace' scope. This will overwrite any existing parameters with the same name. This will not delete old params not included in this list.
rich_parameter_valuesarray of codersdk.WorkspaceBuildParameterfalse
statearray of integerfalse
template_version_idstringfalse
transitioncodersdk.WorkspaceTransitiontrue

Enumerated Values

PropertyValue
transitioncreate
transitionstart
transitionstop
transitiondelete

codersdk.DAUEntry

{
  "amount": 0,
  "date": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequiredRestrictionsDescription
amountintegerfalse
datestringfalse

codersdk.DERP

{
  "config": {
    "path": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "url": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    }
  },
  "server": {
    "enable": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    },
    "region_code": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "region_id": {
      "default": 0,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": 0
    },
    "region_name": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "relay_url": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "stun_addresses": {
      "default": ["string"],
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": ["string"]
    }
  }
}

Properties

NameTypeRequiredRestrictionsDescription
configcodersdk.DERPConfigfalse
servercodersdk.DERPServerConfigfalse

codersdk.DERPConfig

{
  "path": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "url": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  }
}

Properties

NameTypeRequiredRestrictionsDescription
pathcodersdk.DeploymentConfigField-stringfalse
urlcodersdk.DeploymentConfigField-stringfalse

codersdk.DERPRegion

{
  "latency_ms": 0,
  "preferred": true
}

Properties

NameTypeRequiredRestrictionsDescription
latency_msnumberfalse
preferredbooleanfalse

codersdk.DERPServerConfig

{
  "enable": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "region_code": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "region_id": {
    "default": 0,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": 0
  },
  "region_name": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "relay_url": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "stun_addresses": {
    "default": ["string"],
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": ["string"]
  }
}

Properties

codersdk.DangerousConfig

{
  "allow_path_app_sharing": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "allow_path_app_site_owner_access": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  }
}

Properties

NameTypeRequiredRestrictionsDescription
allow_path_app_sharingcodersdk.DeploymentConfigField-boolfalse
allow_path_app_site_owner_accesscodersdk.DeploymentConfigField-boolfalse

codersdk.DeploymentConfig

{
  "access_url": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "address": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "agent_fallback_troubleshooting_url": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "agent_stat_refresh_interval": {
    "default": 0,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": 0
  },
  "audit_logging": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "autobuild_poll_interval": {
    "default": 0,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": 0
  },
  "browser_only": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "cache_directory": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "dangerous": {
    "allow_path_app_sharing": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    },
    "allow_path_app_site_owner_access": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    }
  },
  "derp": {
    "config": {
      "path": {
        "default": "string",
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": "string"
      },
      "url": {
        "default": "string",
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": "string"
      }
    },
    "server": {
      "enable": {
        "default": true,
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": true
      },
      "region_code": {
        "default": "string",
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": "string"
      },
      "region_id": {
        "default": 0,
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": 0
      },
      "region_name": {
        "default": "string",
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": "string"
      },
      "relay_url": {
        "default": "string",
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": "string"
      },
      "stun_addresses": {
        "default": ["string"],
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": ["string"]
      }
    }
  },
  "disable_path_apps": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "experimental": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "experiments": {
    "default": ["string"],
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": ["string"]
  },
  "gitauth": {
    "default": [
      {
        "auth_url": "string",
        "client_id": "string",
        "id": "string",
        "no_refresh": true,
        "regex": "string",
        "scopes": ["string"],
        "token_url": "string",
        "type": "string",
        "validate_url": "string"
      }
    ],
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": [
      {
        "auth_url": "string",
        "client_id": "string",
        "id": "string",
        "no_refresh": true,
        "regex": "string",
        "scopes": ["string"],
        "token_url": "string",
        "type": "string",
        "validate_url": "string"
      }
    ]
  },
  "http_address": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "in_memory_database": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "logging": {
    "human": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "json": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "stackdriver": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    }
  },
  "max_token_lifetime": {
    "default": 0,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": 0
  },
  "metrics_cache_refresh_interval": {
    "default": 0,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": 0
  },
  "oauth2": {
    "github": {
      "allow_everyone": {
        "default": true,
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": true
      },
      "allow_signups": {
        "default": true,
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": true
      },
      "allowed_orgs": {
        "default": ["string"],
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": ["string"]
      },
      "allowed_teams": {
        "default": ["string"],
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": ["string"]
      },
      "client_id": {
        "default": "string",
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": "string"
      },
      "client_secret": {
        "default": "string",
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": "string"
      },
      "enterprise_base_url": {
        "default": "string",
        "enterprise": true,
        "flag": "string",
        "hidden": true,
        "name": "string",
        "secret": true,
        "shorthand": "string",
        "usage": "string",
        "value": "string"
      }
    }
  },
  "oidc": {
    "allow_signups": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    },
    "client_id": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "client_secret": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "email_domain": {
      "default": ["string"],
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": ["string"]
    },
    "icon_url": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "ignore_email_verified": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    },
    "issuer_url": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "scopes": {
      "default": ["string"],
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": ["string"]
    },
    "sign_in_text": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "username_field": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    }
  },
  "pg_connection_url": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "pprof": {
    "address": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "enable": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    }
  },
  "prometheus": {
    "address": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "enable": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    }
  },
  "provisioner": {
    "daemon_poll_interval": {
      "default": 0,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": 0
    },
    "daemon_poll_jitter": {
      "default": 0,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": 0
    },
    "daemons": {
      "default": 0,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": 0
    },
    "force_cancel_interval": {
      "default": 0,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": 0
    }
  },
  "proxy_trusted_headers": {
    "default": ["string"],
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": ["string"]
  },
  "proxy_trusted_origins": {
    "default": ["string"],
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": ["string"]
  },
  "rate_limit": {
    "api": {
      "default": 0,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": 0
    },
    "disable_all": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    }
  },
  "scim_api_key": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "secure_auth_cookie": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "ssh_keygen_algorithm": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "swagger": {
    "enable": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    }
  },
  "telemetry": {
    "enable": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    },
    "trace": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    },
    "url": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    }
  },
  "tls": {
    "address": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "cert_file": {
      "default": ["string"],
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": ["string"]
    },
    "client_auth": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "client_ca_file": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "client_cert_file": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "client_key_file": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "enable": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    },
    "key_file": {
      "default": ["string"],
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": ["string"]
    },
    "min_version": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "redirect_http": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    }
  },
  "trace": {
    "capture_logs": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    },
    "enable": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    },
    "honeycomb_api_key": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    }
  },
  "update_check": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "wildcard_access_url": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  }
}

Properties

NameTypeRequiredRestrictionsDescription
access_urlcodersdk.DeploymentConfigField-stringfalse
addresscodersdk.DeploymentConfigField-stringfalseAddress Use HTTPAddress or TLS.Address instead.
agent_fallback_troubleshooting_urlcodersdk.DeploymentConfigField-stringfalse
agent_stat_refresh_intervalcodersdk.DeploymentConfigField-time_Durationfalse
audit_loggingcodersdk.DeploymentConfigField-boolfalse
autobuild_poll_intervalcodersdk.DeploymentConfigField-time_Durationfalse
browser_onlycodersdk.DeploymentConfigField-boolfalse
cache_directorycodersdk.DeploymentConfigField-stringfalse
dangerouscodersdk.DangerousConfigfalse
derpcodersdk.DERPfalse
disable_path_appscodersdk.DeploymentConfigField-boolfalse
experimentalcodersdk.DeploymentConfigField-boolfalseExperimental Use Experiments instead.
experimentscodersdk.DeploymentConfigField-array_stringfalse
gitauthcodersdk.DeploymentConfigField-array_codersdk_GitAuthConfigfalse
http_addresscodersdk.DeploymentConfigField-stringfalse
in_memory_databasecodersdk.DeploymentConfigField-boolfalse
loggingcodersdk.LoggingConfigfalse
max_token_lifetimecodersdk.DeploymentConfigField-time_Durationfalse
metrics_cache_refresh_intervalcodersdk.DeploymentConfigField-time_Durationfalse
oauth2codersdk.OAuth2Configfalse
oidccodersdk.OIDCConfigfalse
pg_connection_urlcodersdk.DeploymentConfigField-stringfalse
pprofcodersdk.PprofConfigfalse
prometheuscodersdk.PrometheusConfigfalse
provisionercodersdk.ProvisionerConfigfalse
proxy_trusted_headerscodersdk.DeploymentConfigField-array_stringfalse
proxy_trusted_originscodersdk.DeploymentConfigField-array_stringfalse
rate_limitcodersdk.RateLimitConfigfalse
scim_api_keycodersdk.DeploymentConfigField-stringfalse
secure_auth_cookiecodersdk.DeploymentConfigField-boolfalse
ssh_keygen_algorithmcodersdk.DeploymentConfigField-stringfalse
swaggercodersdk.SwaggerConfigfalse
telemetrycodersdk.TelemetryConfigfalse
tlscodersdk.TLSConfigfalse
tracecodersdk.TraceConfigfalse
update_checkcodersdk.DeploymentConfigField-boolfalse
wildcard_access_urlcodersdk.DeploymentConfigField-stringfalse

codersdk.DeploymentConfigField-array_codersdk_GitAuthConfig

{
  "default": [
    {
      "auth_url": "string",
      "client_id": "string",
      "id": "string",
      "no_refresh": true,
      "regex": "string",
      "scopes": ["string"],
      "token_url": "string",
      "type": "string",
      "validate_url": "string"
    }
  ],
  "enterprise": true,
  "flag": "string",
  "hidden": true,
  "name": "string",
  "secret": true,
  "shorthand": "string",
  "usage": "string",
  "value": [
    {
      "auth_url": "string",
      "client_id": "string",
      "id": "string",
      "no_refresh": true,
      "regex": "string",
      "scopes": ["string"],
      "token_url": "string",
      "type": "string",
      "validate_url": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
defaultarray of codersdk.GitAuthConfigfalse
enterprisebooleanfalse
flagstringfalse
hiddenbooleanfalse
namestringfalse
secretbooleanfalse
shorthandstringfalse
usagestringfalse
valuearray of codersdk.GitAuthConfigfalse

codersdk.DeploymentConfigField-array_string

{
  "default": ["string"],
  "enterprise": true,
  "flag": "string",
  "hidden": true,
  "name": "string",
  "secret": true,
  "shorthand": "string",
  "usage": "string",
  "value": ["string"]
}

Properties

NameTypeRequiredRestrictionsDescription
defaultarray of stringfalse
enterprisebooleanfalse
flagstringfalse
hiddenbooleanfalse
namestringfalse
secretbooleanfalse
shorthandstringfalse
usagestringfalse
valuearray of stringfalse

codersdk.DeploymentConfigField-bool

{
  "default": true,
  "enterprise": true,
  "flag": "string",
  "hidden": true,
  "name": "string",
  "secret": true,
  "shorthand": "string",
  "usage": "string",
  "value": true
}

Properties

NameTypeRequiredRestrictionsDescription
defaultbooleanfalse
enterprisebooleanfalse
flagstringfalse
hiddenbooleanfalse
namestringfalse
secretbooleanfalse
shorthandstringfalse
usagestringfalse
valuebooleanfalse

codersdk.DeploymentConfigField-int

{
  "default": 0,
  "enterprise": true,
  "flag": "string",
  "hidden": true,
  "name": "string",
  "secret": true,
  "shorthand": "string",
  "usage": "string",
  "value": 0
}

Properties

NameTypeRequiredRestrictionsDescription
defaultintegerfalse
enterprisebooleanfalse
flagstringfalse
hiddenbooleanfalse
namestringfalse
secretbooleanfalse
shorthandstringfalse
usagestringfalse
valueintegerfalse

codersdk.DeploymentConfigField-string

{
  "default": "string",
  "enterprise": true,
  "flag": "string",
  "hidden": true,
  "name": "string",
  "secret": true,
  "shorthand": "string",
  "usage": "string",
  "value": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
defaultstringfalse
enterprisebooleanfalse
flagstringfalse
hiddenbooleanfalse
namestringfalse
secretbooleanfalse
shorthandstringfalse
usagestringfalse
valuestringfalse

codersdk.DeploymentConfigField-time_Duration

{
  "default": 0,
  "enterprise": true,
  "flag": "string",
  "hidden": true,
  "name": "string",
  "secret": true,
  "shorthand": "string",
  "usage": "string",
  "value": 0
}

Properties

NameTypeRequiredRestrictionsDescription
defaultintegerfalse
enterprisebooleanfalse
flagstringfalse
hiddenbooleanfalse
namestringfalse
secretbooleanfalse
shorthandstringfalse
usagestringfalse
valueintegerfalse

codersdk.DeploymentDAUsResponse

{
  "entries": [
    {
      "amount": 0,
      "date": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
entriesarray of codersdk.DAUEntryfalse

codersdk.Entitlement

"entitled"

Properties

Enumerated Values

Value
entitled
grace_period
not_entitled

codersdk.Entitlements

{
  "errors": ["string"],
  "experimental": true,
  "features": {
    "property1": {
      "actual": 0,
      "enabled": true,
      "entitlement": "entitled",
      "limit": 0
    },
    "property2": {
      "actual": 0,
      "enabled": true,
      "entitlement": "entitled",
      "limit": 0
    }
  },
  "has_license": true,
  "trial": true,
  "warnings": ["string"]
}

Properties

NameTypeRequiredRestrictionsDescription
errorsarray of stringfalse
experimentalbooleanfalseExperimental use Experiments instead.
featuresobjectfalse
» [any property]codersdk.Featurefalse
has_licensebooleanfalse
trialbooleanfalse
warningsarray of stringfalse

codersdk.Experiment

"authz_querier"

Properties

Enumerated Values

Value
authz_querier

codersdk.Feature

{
  "actual": 0,
  "enabled": true,
  "entitlement": "entitled",
  "limit": 0
}

Properties

NameTypeRequiredRestrictionsDescription
actualintegerfalse
enabledbooleanfalse
entitlementcodersdk.Entitlementfalse
limitintegerfalse

codersdk.GenerateAPIKeyResponse

{
  "key": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
keystringfalse

codersdk.GetUsersResponse

{
  "count": 0,
  "users": [
    {
      "avatar_url": "http://example.com",
      "created_at": "2019-08-24T14:15:22Z",
      "email": "[email protected]",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "last_seen_at": "2019-08-24T14:15:22Z",
      "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
      "roles": [
        {
          "display_name": "string",
          "name": "string"
        }
      ],
      "status": "active",
      "username": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
countintegerfalse
usersarray of codersdk.Userfalse

codersdk.GitAuthConfig

{
  "auth_url": "string",
  "client_id": "string",
  "id": "string",
  "no_refresh": true,
  "regex": "string",
  "scopes": ["string"],
  "token_url": "string",
  "type": "string",
  "validate_url": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
auth_urlstringfalse
client_idstringfalse
idstringfalse
no_refreshbooleanfalse
regexstringfalse
scopesarray of stringfalse
token_urlstringfalse
typestringfalse
validate_urlstringfalse

codersdk.GitSSHKey

{
  "created_at": "2019-08-24T14:15:22Z",
  "public_key": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringfalse
public_keystringfalse
updated_atstringfalse
user_idstringfalse

codersdk.Group

{
  "avatar_url": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "members": [
    {
      "avatar_url": "http://example.com",
      "created_at": "2019-08-24T14:15:22Z",
      "email": "[email protected]",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "last_seen_at": "2019-08-24T14:15:22Z",
      "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
      "roles": [
        {
          "display_name": "string",
          "name": "string"
        }
      ],
      "status": "active",
      "username": "string"
    }
  ],
  "name": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "quota_allowance": 0
}

Properties

NameTypeRequiredRestrictionsDescription
avatar_urlstringfalse
idstringfalse
membersarray of codersdk.Userfalse
namestringfalse
organization_idstringfalse
quota_allowanceintegerfalse

codersdk.Healthcheck

{
  "interval": 0,
  "threshold": 0,
  "url": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
intervalintegerfalseInterval specifies the seconds between each health check.
thresholdintegerfalseThreshold specifies the number of consecutive failed health checks before returning "unhealthy".
urlstringfalseURL specifies the endpoint to check for the app health.

codersdk.License

{
  "claims": {},
  "id": 0,
  "uploaded_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Properties

NameTypeRequiredRestrictionsDescription
claimsobjectfalseClaims are the JWT claims asserted by the license. Here we use a generic string map to ensure that all data from the server is parsed verbatim, not just the fields this version of Coder understands.
idintegerfalse
uploaded_atstringfalse
uuidstringfalse

codersdk.LogLevel

"trace"

Properties

Enumerated Values

Value
trace
debug
info
warn
error

codersdk.LogSource

"provisioner_daemon"

Properties

Enumerated Values

Value
provisioner_daemon
provisioner

codersdk.LoggingConfig

{
  "human": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "json": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "stackdriver": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  }
}

Properties

NameTypeRequiredRestrictionsDescription
humancodersdk.DeploymentConfigField-stringfalse
jsoncodersdk.DeploymentConfigField-stringfalse
stackdrivercodersdk.DeploymentConfigField-stringfalse

codersdk.LoginType

"password"

Properties

Enumerated Values

Value
password
github
oidc
token

codersdk.LoginWithPasswordRequest

{
  "email": "[email protected]",
  "password": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
emailstringtrue
passwordstringtrue

codersdk.LoginWithPasswordResponse

{
  "session_token": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
session_tokenstringtrue

codersdk.OAuth2Config

{
  "github": {
    "allow_everyone": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    },
    "allow_signups": {
      "default": true,
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": true
    },
    "allowed_orgs": {
      "default": ["string"],
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": ["string"]
    },
    "allowed_teams": {
      "default": ["string"],
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": ["string"]
    },
    "client_id": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "client_secret": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    },
    "enterprise_base_url": {
      "default": "string",
      "enterprise": true,
      "flag": "string",
      "hidden": true,
      "name": "string",
      "secret": true,
      "shorthand": "string",
      "usage": "string",
      "value": "string"
    }
  }
}

Properties

NameTypeRequiredRestrictionsDescription
githubcodersdk.OAuth2GithubConfigfalse

codersdk.OAuth2GithubConfig

{
  "allow_everyone": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "allow_signups": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "allowed_orgs": {
    "default": ["string"],
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": ["string"]
  },
  "allowed_teams": {
    "default": ["string"],
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": ["string"]
  },
  "client_id": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "client_secret": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "enterprise_base_url": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  }
}

Properties

codersdk.OIDCAuthMethod

{
  "enabled": true,
  "iconUrl": "string",
  "signInText": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
enabledbooleanfalse
iconUrlstringfalse
signInTextstringfalse

codersdk.OIDCConfig

{
  "allow_signups": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "client_id": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "client_secret": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "email_domain": {
    "default": ["string"],
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": ["string"]
  },
  "icon_url": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "ignore_email_verified": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "issuer_url": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "scopes": {
    "default": ["string"],
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": ["string"]
  },
  "sign_in_text": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "username_field": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  }
}

Properties

codersdk.Organization

{
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "updated_at": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringtrue
idstringtrue
namestringtrue
updated_atstringtrue

codersdk.OrganizationMember

{
  "created_at": "2019-08-24T14:15:22Z",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "roles": [
    {
      "display_name": "string",
      "name": "string"
    }
  ],
  "updated_at": "2019-08-24T14:15:22Z",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringfalse
organization_idstringfalse
rolesarray of codersdk.Rolefalse
updated_atstringfalse
user_idstringfalse

codersdk.Parameter

{
  "created_at": "2019-08-24T14:15:22Z",
  "destination_scheme": "none",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "scope": "template",
  "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
  "source_scheme": "none",
  "updated_at": "2019-08-24T14:15:22Z"
}

Parameter represents a set value for the scope.

Properties

NameTypeRequiredRestrictionsDescription
created_atstringfalse
destination_schemecodersdk.ParameterDestinationSchemefalse
idstringfalse
namestringfalse
scopecodersdk.ParameterScopefalse
scope_idstringfalse
source_schemecodersdk.ParameterSourceSchemefalse
updated_atstringfalse

Enumerated Values

PropertyValue
destination_schemenone
destination_schemeenvironment_variable
destination_schemeprovisioner_variable
scopetemplate
scopeworkspace
scopeimport_job
source_schemenone
source_schemedata

codersdk.ParameterDestinationScheme

"none"

Properties

Enumerated Values

Value
none
environment_variable
provisioner_variable

codersdk.ParameterSchema

{
  "allow_override_destination": true,
  "allow_override_source": true,
  "created_at": "2019-08-24T14:15:22Z",
  "default_destination_scheme": "none",
  "default_refresh": "string",
  "default_source_scheme": "none",
  "default_source_value": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "name": "string",
  "redisplay_value": true,
  "validation_condition": "string",
  "validation_contains": ["string"],
  "validation_error": "string",
  "validation_type_system": "string",
  "validation_value_type": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
allow_override_destinationbooleanfalse
allow_override_sourcebooleanfalse
created_atstringfalse
default_destination_schemecodersdk.ParameterDestinationSchemefalse
default_refreshstringfalse
default_source_schemecodersdk.ParameterSourceSchemefalse
default_source_valuestringfalse
descriptionstringfalse
idstringfalse
job_idstringfalse
namestringfalse
redisplay_valuebooleanfalse
validation_conditionstringfalse
validation_containsarray of stringfalseThis is a special array of items provided if the validation condition explicitly states the value must be one of a set.
validation_errorstringfalse
validation_type_systemstringfalse
validation_value_typestringfalse

Enumerated Values

PropertyValue
default_destination_schemenone
default_destination_schemeenvironment_variable
default_destination_schemeprovisioner_variable
default_source_schemenone
default_source_schemedata

codersdk.ParameterScope

"template"

Properties

Enumerated Values

Value
template
workspace
import_job

codersdk.ParameterSourceScheme

"none"

Properties

Enumerated Values

Value
none
data

codersdk.PprofConfig

{
  "address": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "enable": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  }
}

Properties

NameTypeRequiredRestrictionsDescription
addresscodersdk.DeploymentConfigField-stringfalse
enablecodersdk.DeploymentConfigField-boolfalse

codersdk.PrometheusConfig

{
  "address": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "enable": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  }
}

Properties

NameTypeRequiredRestrictionsDescription
addresscodersdk.DeploymentConfigField-stringfalse
enablecodersdk.DeploymentConfigField-boolfalse

codersdk.ProvisionerConfig

{
  "daemon_poll_interval": {
    "default": 0,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": 0
  },
  "daemon_poll_jitter": {
    "default": 0,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": 0
  },
  "daemons": {
    "default": 0,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": 0
  },
  "force_cancel_interval": {
    "default": 0,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": 0
  }
}

Properties

NameTypeRequiredRestrictionsDescription
daemon_poll_intervalcodersdk.DeploymentConfigField-time_Durationfalse
daemon_poll_jittercodersdk.DeploymentConfigField-time_Durationfalse
daemonscodersdk.DeploymentConfigField-intfalse
force_cancel_intervalcodersdk.DeploymentConfigField-time_Durationfalse

codersdk.ProvisionerDaemon

{
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "provisioners": ["string"],
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "updated_at": {
    "time": "string",
    "valid": true
  }
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringfalse
idstringfalse
namestringfalse
provisionersarray of stringfalse
tagsobjectfalse
» [any property]stringfalse
updated_atsql.NullTimefalse

codersdk.ProvisionerJob

{
  "canceled_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "error": "string",
  "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "started_at": "2019-08-24T14:15:22Z",
  "status": "pending",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
}

Properties

NameTypeRequiredRestrictionsDescription
canceled_atstringfalse
completed_atstringfalse
created_atstringfalse
errorstringfalse
file_idstringfalse
idstringfalse
started_atstringfalse
statuscodersdk.ProvisionerJobStatusfalse
tagsobjectfalse
» [any property]stringfalse
worker_idstringfalse

Enumerated Values

PropertyValue
statuspending
statusrunning
statussucceeded
statuscanceling
statuscanceled
statusfailed

codersdk.ProvisionerJobLog

{
  "created_at": "2019-08-24T14:15:22Z",
  "id": 0,
  "log_level": "trace",
  "log_source": "provisioner_daemon",
  "output": "string",
  "stage": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringfalse
idintegerfalse
log_levelcodersdk.LogLevelfalse
log_sourcecodersdk.LogSourcefalse
outputstringfalse
stagestringfalse

Enumerated Values

PropertyValue
log_leveltrace
log_leveldebug
log_levelinfo
log_levelwarn
log_levelerror

codersdk.ProvisionerJobStatus

"pending"

Properties

Enumerated Values

Value
pending
running
succeeded
canceling
canceled
failed

codersdk.PutExtendWorkspaceRequest

{
  "deadline": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequiredRestrictionsDescription
deadlinestringtrue

codersdk.RateLimitConfig

{
  "api": {
    "default": 0,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": 0
  },
  "disable_all": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  }
}

Properties

NameTypeRequiredRestrictionsDescription
apicodersdk.DeploymentConfigField-intfalse
disable_allcodersdk.DeploymentConfigField-boolfalse

codersdk.Replica

{
  "created_at": "2019-08-24T14:15:22Z",
  "database_latency": 0,
  "error": "string",
  "hostname": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "region_id": 0,
  "relay_address": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringfalseCreated at is the timestamp when the replica was first seen.
database_latencyintegerfalseDatabase latency is the latency in microseconds to the database.
errorstringfalseError is the replica error.
hostnamestringfalseHostname is the hostname of the replica.
idstringfalseID is the unique identifier for the replica.
region_idintegerfalseRegion ID is the region of the replica.
relay_addressstringfalseRelay address is the accessible address to relay DERP connections.

codersdk.ResourceType

"template"

Properties

Enumerated Values

Value
template
template_version
user
workspace
workspace_build
git_ssh_key
api_key
group

codersdk.Response

{
  "detail": "string",
  "message": "string",
  "validations": [
    {
      "detail": "string",
      "field": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
detailstringfalseDetail is a debug message that provides further insight into why the action failed. This information can be technical and a regular golang err.Error() text. - "database: too many open connections" - "stat: too many open files"
messagestringfalseMessage is an actionable message that depicts actions the request took. These messages should be fully formed sentences with proper punctuation. Examples: - "A user has been created." - "Failed to create a user."
validationsarray of codersdk.ValidationErrorfalseValidations are form field-specific friendly error messages. They will be shown on a form field in the UI. These can also be used to add additional context if there is a set of errors in the primary 'Message'.

codersdk.Role

{
  "display_name": "string",
  "name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
display_namestringfalse
namestringfalse

codersdk.ServiceBannerConfig

{
  "background_color": "string",
  "enabled": true,
  "message": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
background_colorstringfalse
enabledbooleanfalse
messagestringfalse

codersdk.SwaggerConfig

{
  "enable": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  }
}

Properties

NameTypeRequiredRestrictionsDescription
enablecodersdk.DeploymentConfigField-boolfalse

codersdk.TLSConfig

{
  "address": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "cert_file": {
    "default": ["string"],
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": ["string"]
  },
  "client_auth": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "client_ca_file": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "client_cert_file": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "client_key_file": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "enable": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "key_file": {
    "default": ["string"],
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": ["string"]
  },
  "min_version": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  },
  "redirect_http": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  }
}

Properties

codersdk.TelemetryConfig

{
  "enable": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "trace": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "url": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  }
}

Properties

codersdk.Template

{
  "active_user_count": 0,
  "active_version_id": "eae64611-bd53-4a80-bb77-df1e432c0fbc",
  "allow_user_cancel_workspace_jobs": true,
  "build_time_stats": {
    "property1": {
      "p50": 123,
      "p95": 146
    },
    "property2": {
      "p50": 123,
      "p95": 146
    }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
  "created_by_name": "string",
  "default_ttl_ms": 0,
  "description": "string",
  "display_name": "string",
  "icon": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "provisioner": "terraform",
  "updated_at": "2019-08-24T14:15:22Z",
  "workspace_owner_count": 0
}

Properties

NameTypeRequiredRestrictionsDescription
active_user_countintegerfalseActive user count is set to -1 when loading.
active_version_idstringfalse
allow_user_cancel_workspace_jobsbooleanfalse
build_time_statscodersdk.TemplateBuildTimeStatsfalse
created_atstringfalse
created_by_idstringfalse
created_by_namestringfalse
default_ttl_msintegerfalse
descriptionstringfalse
display_namestringfalse
iconstringfalse
idstringfalse
namestringfalse
organization_idstringfalse
provisionerstringfalse
updated_atstringfalse
workspace_owner_countintegerfalse

Enumerated Values

PropertyValue
provisionerterraform

codersdk.TemplateBuildTimeStats

{
  "property1": {
    "p50": 123,
    "p95": 146
  },
  "property2": {
    "p50": 123,
    "p95": 146
  }
}

Properties

NameTypeRequiredRestrictionsDescription
[any property]codersdk.TransitionStatsfalse

codersdk.TemplateDAUsResponse

{
  "entries": [
    {
      "amount": 0,
      "date": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
entriesarray of codersdk.DAUEntryfalse

codersdk.TemplateExample

{
  "description": "string",
  "icon": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "markdown": "string",
  "name": "string",
  "tags": ["string"],
  "url": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
descriptionstringfalse
iconstringfalse
idstringfalse
markdownstringfalse
namestringfalse
tagsarray of stringfalse
urlstringfalse

codersdk.TemplateRole

"admin"

Properties

Enumerated Values

Value
admin
use
``

codersdk.TemplateUser

{
  "avatar_url": "http://example.com",
  "created_at": "2019-08-24T14:15:22Z",
  "email": "[email protected]",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "last_seen_at": "2019-08-24T14:15:22Z",
  "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
  "role": "admin",
  "roles": [
    {
      "display_name": "string",
      "name": "string"
    }
  ],
  "status": "active",
  "username": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
avatar_urlstringfalse
created_atstringtrue
emailstringtrue
idstringtrue
last_seen_atstringfalse
organization_idsarray of stringfalse
rolecodersdk.TemplateRolefalse
rolesarray of codersdk.Rolefalse
statuscodersdk.UserStatusfalse
usernamestringtrue

Enumerated Values

PropertyValue
roleadmin
roleuse
statusactive
statussuspended

codersdk.TemplateVersion

{
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "avatar_url": "http://example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "email": "[email protected]",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "last_seen_at": "2019-08-24T14:15:22Z",
    "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
    "roles": [
      {
        "display_name": "string",
        "name": "string"
      }
    ],
    "status": "active",
    "username": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "job": {
    "canceled_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "error": "string",
    "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "started_at": "2019-08-24T14:15:22Z",
    "status": "pending",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
  },
  "name": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "readme": "string",
  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  "updated_at": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringfalse
created_bycodersdk.Userfalse
idstringfalse
jobcodersdk.ProvisionerJobfalse
namestringfalse
organization_idstringfalse
readmestringfalse
template_idstringfalse
updated_atstringfalse

codersdk.TraceConfig

{
  "capture_logs": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "enable": {
    "default": true,
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": true
  },
  "honeycomb_api_key": {
    "default": "string",
    "enterprise": true,
    "flag": "string",
    "hidden": true,
    "name": "string",
    "secret": true,
    "shorthand": "string",
    "usage": "string",
    "value": "string"
  }
}

Properties

NameTypeRequiredRestrictionsDescription
capture_logscodersdk.DeploymentConfigField-boolfalse
enablecodersdk.DeploymentConfigField-boolfalse
honeycomb_api_keycodersdk.DeploymentConfigField-stringfalse

codersdk.TransitionStats

{
  "p50": 123,
  "p95": 146
}

Properties

NameTypeRequiredRestrictionsDescription
p50integerfalse
p95integerfalse

codersdk.UpdateActiveTemplateVersion

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Properties

NameTypeRequiredRestrictionsDescription
idstringtrue

codersdk.UpdateCheckResponse

{
  "current": true,
  "url": "string",
  "version": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
currentbooleanfalseCurrent indicates whether the server version is the same as the latest.
urlstringfalseURL to download the latest release of Coder.
versionstringfalseVersion is the semantic version for the latest release of Coder.

codersdk.UpdateRoles

{
  "roles": ["string"]
}

Properties

NameTypeRequiredRestrictionsDescription
rolesarray of stringfalse

codersdk.UpdateTemplateACL

{
  "group_perms": {
    "property1": "admin",
    "property2": "admin"
  },
  "user_perms": {
    "property1": "admin",
    "property2": "admin"
  }
}

Properties

NameTypeRequiredRestrictionsDescription
group_permsobjectfalse
» [any property]codersdk.TemplateRolefalse
user_permsobjectfalse
» [any property]codersdk.TemplateRolefalse

codersdk.UpdateUserPasswordRequest

{
  "old_password": "string",
  "password": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
old_passwordstringfalse
passwordstringtrue

codersdk.UpdateUserProfileRequest

{
  "username": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
usernamestringtrue

codersdk.UpdateWorkspaceAutostartRequest

{
  "schedule": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
schedulestringfalse

codersdk.UpdateWorkspaceRequest

{
  "name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
namestringfalse

codersdk.UpdateWorkspaceTTLRequest

{
  "ttl_ms": 0
}

Properties

NameTypeRequiredRestrictionsDescription
ttl_msintegerfalse

codersdk.UploadResponse

{
  "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd"
}

Properties

NameTypeRequiredRestrictionsDescription
hashstringfalse

codersdk.User

{
  "avatar_url": "http://example.com",
  "created_at": "2019-08-24T14:15:22Z",
  "email": "[email protected]",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "last_seen_at": "2019-08-24T14:15:22Z",
  "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
  "roles": [
    {
      "display_name": "string",
      "name": "string"
    }
  ],
  "status": "active",
  "username": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
avatar_urlstringfalse
created_atstringtrue
emailstringtrue
idstringtrue
last_seen_atstringfalse
organization_idsarray of stringfalse
rolesarray of codersdk.Rolefalse
statuscodersdk.UserStatusfalse
usernamestringtrue

Enumerated Values

PropertyValue
statusactive
statussuspended

codersdk.UserStatus

"active"

Properties

Enumerated Values

Value
active
suspended

codersdk.ValidationError

{
  "detail": "string",
  "field": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
detailstringtrue
fieldstringtrue

codersdk.Workspace

{
  "autostart_schedule": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "last_used_at": "2019-08-24T14:15:22Z",
  "latest_build": {
    "build_number": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "daily_cost": 0,
    "deadline": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
    "initiator_name": "string",
    "job": {
      "canceled_at": "2019-08-24T14:15:22Z",
      "completed_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "error": "string",
      "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "started_at": "2019-08-24T14:15:22Z",
      "status": "pending",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
    },
    "reason": "initiator",
    "resources": [
      {
        "agents": [
          {
            "apps": [
              {
                "command": "string",
                "display_name": "string",
                "external": true,
                "health": "disabled",
                "healthcheck": {
                  "interval": 0,
                  "threshold": 0,
                  "url": "string"
                },
                "icon": "string",
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "sharing_level": "owner",
                "slug": "string",
                "subdomain": true,
                "url": "string"
              }
            ],
            "architecture": "string",
            "connection_timeout_seconds": 0,
            "created_at": "2019-08-24T14:15:22Z",
            "directory": "string",
            "disconnected_at": "2019-08-24T14:15:22Z",
            "environment_variables": {
              "property1": "string",
              "property2": "string"
            },
            "first_connected_at": "2019-08-24T14:15:22Z",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "instance_id": "string",
            "last_connected_at": "2019-08-24T14:15:22Z",
            "latency": {
              "property1": {
                "latency_ms": 0,
                "preferred": true
              },
              "property2": {
                "latency_ms": 0,
                "preferred": true
              }
            },
            "lifecycle_state": "created",
            "login_before_ready": true,
            "name": "string",
            "operating_system": "string",
            "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
            "startup_script": "string",
            "startup_script_timeout_seconds": 0,
            "status": "connecting",
            "troubleshooting_url": "string",
            "updated_at": "2019-08-24T14:15:22Z",
            "version": "string"
          }
        ],
        "created_at": "2019-08-24T14:15:22Z",
        "daily_cost": 0,
        "hide": true,
        "icon": "string",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
        "metadata": [
          {
            "key": "string",
            "sensitive": true,
            "value": "string"
          }
        ],
        "name": "string",
        "type": "string",
        "workspace_transition": "start"
      }
    ],
    "status": "pending",
    "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
    "template_version_name": "string",
    "transition": "start",
    "updated_at": "2019-08-24T14:15:22Z",
    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
    "workspace_name": "string",
    "workspace_owner_id": "e7078695-5279-4c86-8774-3ac2367a2fc7",
    "workspace_owner_name": "string"
  },
  "name": "string",
  "outdated": true,
  "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  "owner_name": "string",
  "template_allow_user_cancel_workspace_jobs": true,
  "template_display_name": "string",
  "template_icon": "string",
  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  "template_name": "string",
  "ttl_ms": 0,
  "updated_at": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequiredRestrictionsDescription
autostart_schedulestringfalse
created_atstringfalse
idstringfalse
last_used_atstringfalse
latest_buildcodersdk.WorkspaceBuildfalse
namestringfalse
outdatedbooleanfalse
owner_idstringfalse
owner_namestringfalse
template_allow_user_cancel_workspace_jobsbooleanfalse
template_display_namestringfalse
template_iconstringfalse
template_idstringfalse
template_namestringfalse
ttl_msintegerfalse
updated_atstringfalse

codersdk.WorkspaceAgent

{
  "apps": [
    {
      "command": "string",
      "display_name": "string",
      "external": true,
      "health": "disabled",
      "healthcheck": {
        "interval": 0,
        "threshold": 0,
        "url": "string"
      },
      "icon": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "sharing_level": "owner",
      "slug": "string",
      "subdomain": true,
      "url": "string"
    }
  ],
  "architecture": "string",
  "connection_timeout_seconds": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "directory": "string",
  "disconnected_at": "2019-08-24T14:15:22Z",
  "environment_variables": {
    "property1": "string",
    "property2": "string"
  },
  "first_connected_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "instance_id": "string",
  "last_connected_at": "2019-08-24T14:15:22Z",
  "latency": {
    "property1": {
      "latency_ms": 0,
      "preferred": true
    },
    "property2": {
      "latency_ms": 0,
      "preferred": true
    }
  },
  "lifecycle_state": "created",
  "login_before_ready": true,
  "name": "string",
  "operating_system": "string",
  "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
  "startup_script": "string",
  "startup_script_timeout_seconds": 0,
  "status": "connecting",
  "troubleshooting_url": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "version": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
appsarray of codersdk.WorkspaceAppfalse
architecturestringfalse
connection_timeout_secondsintegerfalse
created_atstringfalse
directorystringfalse
disconnected_atstringfalse
environment_variablesobjectfalse
» [any property]stringfalse
first_connected_atstringfalse
idstringfalse
instance_idstringfalse
last_connected_atstringfalse
latencyobjectfalseLatency is mapped by region name (e.g. "New York City", "Seattle").
» [any property]codersdk.DERPRegionfalse
lifecycle_statecodersdk.WorkspaceAgentLifecyclefalse
login_before_readybooleanfalseLogin before ready if true, the agent will delay logins until it is ready (e.g. executing startup script has ended).
namestringfalse
operating_systemstringfalse
resource_idstringfalse
startup_scriptstringfalse
startup_script_timeout_secondsintegerfalseStartup script timeout seconds is the number of seconds to wait for the startup script to complete. If the script does not complete within this time, the agent lifecycle will be marked as start_timeout.
statuscodersdk.WorkspaceAgentStatusfalse
troubleshooting_urlstringfalse
updated_atstringfalse
versionstringfalse

codersdk.WorkspaceAgentConnectionInfo

{
  "derp_map": {
    "omitDefaultRegions": true,
    "regions": {
      "property1": {
        "avoid": true,
        "embeddedRelay": true,
        "nodes": [
          {
            "certName": "string",
            "derpport": 0,
            "forceHTTP": true,
            "hostName": "string",
            "insecureForTests": true,
            "ipv4": "string",
            "ipv6": "string",
            "name": "string",
            "regionID": 0,
            "stunonly": true,
            "stunport": 0,
            "stuntestIP": "string"
          }
        ],
        "regionCode": "string",
        "regionID": 0,
        "regionName": "string"
      },
      "property2": {
        "avoid": true,
        "embeddedRelay": true,
        "nodes": [
          {
            "certName": "string",
            "derpport": 0,
            "forceHTTP": true,
            "hostName": "string",
            "insecureForTests": true,
            "ipv4": "string",
            "ipv6": "string",
            "name": "string",
            "regionID": 0,
            "stunonly": true,
            "stunport": 0,
            "stuntestIP": "string"
          }
        ],
        "regionCode": "string",
        "regionID": 0,
        "regionName": "string"
      }
    }
  }
}

Properties

NameTypeRequiredRestrictionsDescription
derp_maptailcfg.DERPMapfalse

codersdk.WorkspaceAgentLifecycle

"created"

Properties

Enumerated Values

Value
created
starting
start_timeout
start_error
ready

codersdk.WorkspaceAgentListeningPort

{
  "network": "string",
  "port": 0,
  "process_name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
networkstringfalseonly "tcp" at the moment
portintegerfalse
process_namestringfalsemay be empty

codersdk.WorkspaceAgentListeningPortsResponse

{
  "ports": [
    {
      "network": "string",
      "port": 0,
      "process_name": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
portsarray of codersdk.WorkspaceAgentListeningPortfalseIf there are no ports in the list, nothing should be displayed in the UI. There must not be a "no ports available" message or anything similar, as there will always be no ports displayed on platforms where our port detection logic is unsupported.

codersdk.WorkspaceAgentStatus

"connecting"

Properties

Enumerated Values

Value
connecting
connected
disconnected
timeout

codersdk.WorkspaceApp

{
  "command": "string",
  "display_name": "string",
  "external": true,
  "health": "disabled",
  "healthcheck": {
    "interval": 0,
    "threshold": 0,
    "url": "string"
  },
  "icon": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "sharing_level": "owner",
  "slug": "string",
  "subdomain": true,
  "url": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
commandstringfalse
display_namestringfalseDisplay name is a friendly name for the app.
externalbooleanfalseExternal specifies whether the URL should be opened externally on the client or not.
healthcodersdk.WorkspaceAppHealthfalse
healthcheckcodersdk.HealthcheckfalseHealthcheck specifies the configuration for checking app health.
iconstringfalseIcon is a relative path or external URL that specifies an icon to be displayed in the dashboard.
idstringfalse
sharing_levelcodersdk.WorkspaceAppSharingLevelfalse
slugstringfalseSlug is a unique identifier within the agent.
subdomainbooleanfalseSubdomain denotes whether the app should be accessed via a path on the coder server or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI.
urlstringfalseURL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client.

Enumerated Values

PropertyValue
sharing_levelowner
sharing_levelauthenticated
sharing_levelpublic

codersdk.WorkspaceAppHealth

"disabled"

Properties

Enumerated Values

Value
disabled
initializing
healthy
unhealthy

codersdk.WorkspaceAppSharingLevel

"owner"

Properties

Enumerated Values

Value
owner
authenticated
public

codersdk.WorkspaceBuild

{
  "build_number": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "daily_cost": 0,
  "deadline": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
  "initiator_name": "string",
  "job": {
    "canceled_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "error": "string",
    "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "started_at": "2019-08-24T14:15:22Z",
    "status": "pending",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
  },
  "reason": "initiator",
  "resources": [
    {
      "agents": [
        {
          "apps": [
            {
              "command": "string",
              "display_name": "string",
              "external": true,
              "health": "disabled",
              "healthcheck": {
                "interval": 0,
                "threshold": 0,
                "url": "string"
              },
              "icon": "string",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "sharing_level": "owner",
              "slug": "string",
              "subdomain": true,
              "url": "string"
            }
          ],
          "architecture": "string",
          "connection_timeout_seconds": 0,
          "created_at": "2019-08-24T14:15:22Z",
          "directory": "string",
          "disconnected_at": "2019-08-24T14:15:22Z",
          "environment_variables": {
            "property1": "string",
            "property2": "string"
          },
          "first_connected_at": "2019-08-24T14:15:22Z",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "instance_id": "string",
          "last_connected_at": "2019-08-24T14:15:22Z",
          "latency": {
            "property1": {
              "latency_ms": 0,
              "preferred": true
            },
            "property2": {
              "latency_ms": 0,
              "preferred": true
            }
          },
          "lifecycle_state": "created",
          "login_before_ready": true,
          "name": "string",
          "operating_system": "string",
          "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
          "startup_script": "string",
          "startup_script_timeout_seconds": 0,
          "status": "connecting",
          "troubleshooting_url": "string",
          "updated_at": "2019-08-24T14:15:22Z",
          "version": "string"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "daily_cost": 0,
      "hide": true,
      "icon": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
      "metadata": [
        {
          "key": "string",
          "sensitive": true,
          "value": "string"
        }
      ],
      "name": "string",
      "type": "string",
      "workspace_transition": "start"
    }
  ],
  "status": "pending",
  "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
  "template_version_name": "string",
  "transition": "start",
  "updated_at": "2019-08-24T14:15:22Z",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "workspace_name": "string",
  "workspace_owner_id": "e7078695-5279-4c86-8774-3ac2367a2fc7",
  "workspace_owner_name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
build_numberintegerfalse
created_atstringfalse
daily_costintegerfalse
deadlinestringfalse
idstringfalse
initiator_idstringfalse
initiator_namestringfalse
jobcodersdk.ProvisionerJobfalse
reasoncodersdk.BuildReasonfalse
resourcesarray of codersdk.WorkspaceResourcefalse
statuscodersdk.WorkspaceStatusfalse
template_version_idstringfalse
template_version_namestringfalse
transitioncodersdk.WorkspaceTransitionfalse
updated_atstringfalse
workspace_idstringfalse
workspace_namestringfalse
workspace_owner_idstringfalse
workspace_owner_namestringfalse

Enumerated Values

PropertyValue
reasoninitiator
reasonautostart
reasonautostop
statuspending
statusstarting
statusrunning
statusstopping
statusstopped
statusfailed
statuscanceling
statuscanceled
statusdeleting
statusdeleted
transitionstart
transitionstop
transitiondelete

codersdk.WorkspaceBuildParameter

{
  "name": "string",
  "value": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
namestringfalse
valuestringfalse

codersdk.WorkspaceQuota

{
  "budget": 0,
  "credits_consumed": 0
}

Properties

NameTypeRequiredRestrictionsDescription
budgetintegerfalse
credits_consumedintegerfalse

codersdk.WorkspaceResource

{
  "agents": [
    {
      "apps": [
        {
          "command": "string",
          "display_name": "string",
          "external": true,
          "health": "disabled",
          "healthcheck": {
            "interval": 0,
            "threshold": 0,
            "url": "string"
          },
          "icon": "string",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "sharing_level": "owner",
          "slug": "string",
          "subdomain": true,
          "url": "string"
        }
      ],
      "architecture": "string",
      "connection_timeout_seconds": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "directory": "string",
      "disconnected_at": "2019-08-24T14:15:22Z",
      "environment_variables": {
        "property1": "string",
        "property2": "string"
      },
      "first_connected_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "instance_id": "string",
      "last_connected_at": "2019-08-24T14:15:22Z",
      "latency": {
        "property1": {
          "latency_ms": 0,
          "preferred": true
        },
        "property2": {
          "latency_ms": 0,
          "preferred": true
        }
      },
      "lifecycle_state": "created",
      "login_before_ready": true,
      "name": "string",
      "operating_system": "string",
      "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
      "startup_script": "string",
      "startup_script_timeout_seconds": 0,
      "status": "connecting",
      "troubleshooting_url": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "version": "string"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "daily_cost": 0,
  "hide": true,
  "icon": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "metadata": [
    {
      "key": "string",
      "sensitive": true,
      "value": "string"
    }
  ],
  "name": "string",
  "type": "string",
  "workspace_transition": "start"
}

Properties

NameTypeRequiredRestrictionsDescription
agentsarray of codersdk.WorkspaceAgentfalse
created_atstringfalse
daily_costintegerfalse
hidebooleanfalse
iconstringfalse
idstringfalse
job_idstringfalse
metadataarray of codersdk.WorkspaceResourceMetadatafalse
namestringfalse
typestringfalse
workspace_transitioncodersdk.WorkspaceTransitionfalse

Enumerated Values

PropertyValue
workspace_transitionstart
workspace_transitionstop
workspace_transitiondelete

codersdk.WorkspaceResourceMetadata

{
  "key": "string",
  "sensitive": true,
  "value": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
keystringfalse
sensitivebooleanfalse
valuestringfalse

codersdk.WorkspaceStatus

"pending"

Properties

Enumerated Values

Value
pending
starting
running
stopping
stopped
failed
canceling
canceled
deleting
deleted

codersdk.WorkspaceTransition

"start"

Properties

Enumerated Values

Value
start
stop
delete

codersdk.WorkspacesResponse

{
  "count": 0,
  "workspaces": [
    {
      "autostart_schedule": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "last_used_at": "2019-08-24T14:15:22Z",
      "latest_build": {
        "build_number": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "daily_cost": 0,
        "deadline": "2019-08-24T14:15:22Z",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
        "initiator_name": "string",
        "job": {
          "canceled_at": "2019-08-24T14:15:22Z",
          "completed_at": "2019-08-24T14:15:22Z",
          "created_at": "2019-08-24T14:15:22Z",
          "error": "string",
          "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "started_at": "2019-08-24T14:15:22Z",
          "status": "pending",
          "tags": {
            "property1": "string",
            "property2": "string"
          },
          "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
        },
        "reason": "initiator",
        "resources": [
          {
            "agents": [
              {
                "apps": [
                  {
                    "command": "string",
                    "display_name": "string",
                    "external": true,
                    "health": "disabled",
                    "healthcheck": {},
                    "icon": "string",
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "sharing_level": "owner",
                    "slug": "string",
                    "subdomain": true,
                    "url": "string"
                  }
                ],
                "architecture": "string",
                "connection_timeout_seconds": 0,
                "created_at": "2019-08-24T14:15:22Z",
                "directory": "string",
                "disconnected_at": "2019-08-24T14:15:22Z",
                "environment_variables": {
                  "property1": "string",
                  "property2": "string"
                },
                "first_connected_at": "2019-08-24T14:15:22Z",
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "instance_id": "string",
                "last_connected_at": "2019-08-24T14:15:22Z",
                "latency": {
                  "property1": {
                    "latency_ms": 0,
                    "preferred": true
                  },
                  "property2": {
                    "latency_ms": 0,
                    "preferred": true
                  }
                },
                "lifecycle_state": "created",
                "login_before_ready": true,
                "name": "string",
                "operating_system": "string",
                "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
                "startup_script": "string",
                "startup_script_timeout_seconds": 0,
                "status": "connecting",
                "troubleshooting_url": "string",
                "updated_at": "2019-08-24T14:15:22Z",
                "version": "string"
              }
            ],
            "created_at": "2019-08-24T14:15:22Z",
            "daily_cost": 0,
            "hide": true,
            "icon": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
            "metadata": [
              {
                "key": "string",
                "sensitive": true,
                "value": "string"
              }
            ],
            "name": "string",
            "type": "string",
            "workspace_transition": "start"
          }
        ],
        "status": "pending",
        "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
        "template_version_name": "string",
        "transition": "start",
        "updated_at": "2019-08-24T14:15:22Z",
        "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
        "workspace_name": "string",
        "workspace_owner_id": "e7078695-5279-4c86-8774-3ac2367a2fc7",
        "workspace_owner_name": "string"
      },
      "name": "string",
      "outdated": true,
      "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
      "owner_name": "string",
      "template_allow_user_cancel_workspace_jobs": true,
      "template_display_name": "string",
      "template_icon": "string",
      "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
      "template_name": "string",
      "ttl_ms": 0,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
countintegerfalse
workspacesarray of codersdk.Workspacefalse

database.ParameterDestinationScheme

"none"

Properties

Enumerated Values

Value
none
environment_variable
provisioner_variable

database.ParameterScope

"template"

Properties

Enumerated Values

Value
template
import_job
workspace

database.ParameterSourceScheme

"none"

Properties

Enumerated Values

Value
none
data

parameter.ComputedValue

{
  "created_at": "string",
  "default_source_value": true,
  "destination_scheme": "none",
  "id": "string",
  "name": "string",
  "schema_id": "string",
  "scope": "template",
  "scope_id": "string",
  "source_scheme": "none",
  "source_value": "string",
  "updated_at": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringfalse
default_source_valuebooleanfalse
destination_schemedatabase.ParameterDestinationSchemefalse
idstringfalse
namestringfalse
schema_idstringfalse
scopedatabase.ParameterScopefalse
scope_idstringfalse
source_schemedatabase.ParameterSourceSchemefalse
source_valuestringfalse
updated_atstringfalse

sql.NullTime

{
  "time": "string",
  "valid": true
}

Properties

NameTypeRequiredRestrictionsDescription
timestringfalse
validbooleanfalseValid is true if Time is not NULL

tailcfg.DERPMap

{
  "omitDefaultRegions": true,
  "regions": {
    "property1": {
      "avoid": true,
      "embeddedRelay": true,
      "nodes": [
        {
          "certName": "string",
          "derpport": 0,
          "forceHTTP": true,
          "hostName": "string",
          "insecureForTests": true,
          "ipv4": "string",
          "ipv6": "string",
          "name": "string",
          "regionID": 0,
          "stunonly": true,
          "stunport": 0,
          "stuntestIP": "string"
        }
      ],
      "regionCode": "string",
      "regionID": 0,
      "regionName": "string"
    },
    "property2": {
      "avoid": true,
      "embeddedRelay": true,
      "nodes": [
        {
          "certName": "string",
          "derpport": 0,
          "forceHTTP": true,
          "hostName": "string",
          "insecureForTests": true,
          "ipv4": "string",
          "ipv6": "string",
          "name": "string",
          "regionID": 0,
          "stunonly": true,
          "stunport": 0,
          "stuntestIP": "string"
        }
      ],
      "regionCode": "string",
      "regionID": 0,
      "regionName": "string"
    }
  }
}

Properties

NameTypeRequiredRestrictionsDescription
omitDefaultRegionsbooleanfalseOmitdefaultregions specifies to not use Tailscale's DERP servers, and only use those specified in this DERPMap. If there are none set outside of the defaults, this is a noop.
regionsobjectfalseRegions is the set of geographic regions running DERP node(s).

It's keyed by the DERPRegion.RegionID. The numbers are not necessarily contiguous.| |» [any property]|tailcfg.DERPRegion|false|||

tailcfg.DERPNode

{
  "certName": "string",
  "derpport": 0,
  "forceHTTP": true,
  "hostName": "string",
  "insecureForTests": true,
  "ipv4": "string",
  "ipv6": "string",
  "name": "string",
  "regionID": 0,
  "stunonly": true,
  "stunport": 0,
  "stuntestIP": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
certNamestringfalseCertname optionally specifies the expected TLS cert common name. If empty, HostName is used. If CertName is non-empty, HostName is only used for the TCP dial (if IPv4/IPv6 are not present) + TLS ClientHello.
derpportintegerfalseDerpport optionally provides an alternate TLS port number for the DERP HTTPS server.
If zero, 443 is used.
forceHTTPbooleanfalseForcehttp is used by unit tests to force HTTP. It should not be set by users.
hostNamestringfalseHostname is the DERP node's hostname.
It is required but need not be unique; multiple nodes may have the same HostName but vary in configuration otherwise.
insecureForTestsbooleanfalseInsecurefortests is used by unit tests to disable TLS verification. It should not be set by users.
ipv4stringfalseIpv4 optionally forces an IPv4 address to use, instead of using DNS. If empty, A record(s) from DNS lookups of HostName are used. If the string is not an IPv4 address, IPv4 is not used; the conventional string to disable IPv4 (and not use DNS) is "none".
ipv6stringfalseIpv6 optionally forces an IPv6 address to use, instead of using DNS. If empty, AAAA record(s) from DNS lookups of HostName are used. If the string is not an IPv6 address, IPv6 is not used; the conventional string to disable IPv6 (and not use DNS) is "none".
namestringfalseName is a unique node name (across all regions). It is not a host name. It's typically of the form "1b", "2a", "3b", etc. (region ID + suffix within that region)
regionIDintegerfalseRegionid is the RegionID of the DERPRegion that this node is running in.
stunonlybooleanfalseStunonly marks a node as only a STUN server and not a DERP server.
stunportintegerfalsePort optionally specifies a STUN port to use. Zero means 3478. To disable STUN on this node, use -1.
stuntestIPstringfalseStuntestip is used in tests to override the STUN server's IP. If empty, it's assumed to be the same as the DERP server.

tailcfg.DERPRegion

{
  "avoid": true,
  "embeddedRelay": true,
  "nodes": [
    {
      "certName": "string",
      "derpport": 0,
      "forceHTTP": true,
      "hostName": "string",
      "insecureForTests": true,
      "ipv4": "string",
      "ipv6": "string",
      "name": "string",
      "regionID": 0,
      "stunonly": true,
      "stunport": 0,
      "stuntestIP": "string"
    }
  ],
  "regionCode": "string",
  "regionID": 0,
  "regionName": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
avoidbooleanfalseAvoid is whether the client should avoid picking this as its home region. The region should only be used if a peer is there. Clients already using this region as their home should migrate away to a new region without Avoid set.
embeddedRelaybooleanfalseEmbeddedrelay is true when the region is bundled with the Coder control plane.
nodesarray of tailcfg.DERPNodefalseNodes are the DERP nodes running in this region, in priority order for the current client. Client TLS connections should ideally only go to the first entry (falling back to the second if necessary). STUN packets should go to the first 1 or 2.
If nodes within a region route packets amongst themselves, but not to other regions. That said, each user/domain should get a the same preferred node order, so if all nodes for a user/network pick the first one (as they should, when things are healthy), the inter-cluster routing is minimal to zero.
regionCodestringfalseRegioncode is a short name for the region. It's usually a popular city or airport code in the region: "nyc", "sf", "sin", "fra", etc.
regionIDintegerfalseRegionid is a unique integer for a geographic region.

It corresponds to the legacy derpN.tailscale.com hostnames used by older clients. (Older clients will continue to resolve derpN.tailscale.com when contacting peers, rather than use the server-provided DERPMap) RegionIDs must be non-zero, positive, and guaranteed to fit in a JavaScript number. RegionIDs in range 900-999 are reserved for end users to run their own DERP nodes.| |regionName|string|false||Regionname is a long English name for the region: "New York City", "San Francisco", "Singapore", "Frankfurt", etc.|

See an opportunity to improve our docs? Make an edit.
On this page