--- title: "Get a source" canonical: "https://admiral.io/docs/api/sources/SourceAPI_GetSource" --- # Get a source `GET https://api.admiral.io/v1/sources/{source_id}` Scope: `source:read` ### Path parameters - `source_id` (string, required): The source_id path parameter. Pattern `^src-[0-9a-z]+$`. ### Response 200 Success - `source` (Source): source.grant_present // a source carries exactly one grant, a credential or an integration source.integration_is_git // an integration reaches a git repository source.push_names_branches // a push source names the branches whose pushes publish source.push_needs_integration // a push source is reached through the GitHub integration source.settings_match_kind // git settings belong to a git source - At most one of `credential_id`, `integration_id` is set. - `id` (string): Pattern `^src-[0-9a-z]+$`. Read-only. - `name` (string): Unique within the organization. Typed by the administrator who creates the source, so like a credential's name it starts with a letter. Pattern `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. Length 1 to 63. - `description` (string): Length at most 1024. - `kind` (Kind): (IMMUTABLE) enum.defined_only = true One of `KIND_GIT`, `KIND_HELM_REPO`, `KIND_OCI_REGISTRY`, `KIND_TERRAFORM_REGISTRY`. - `location` (string): (IMMUTABLE) The narrowest thing the protocol addresses: one repository, one Helm repository URL, one registry namespace. Never a bare host, and never a whole GitHub organization. Picking the source is picking the grant, so the location is what bounds the grant's reach. Length 1 to 512. - `trigger` (Trigger): enum.defined_only = true One of `TRIGGER_REQUEST`, `TRIGGER_PUSH`. - `allows` (array of string): What may enter through the source: artifact names, exact or with a trailing `*`. For a git source an artifact is a path in the repository; for a Helm repository a chart name; for a registry a name under the namespace. Required and never empty; `*` alone is how a source says everything. An allow list, enforced on the server at import and at push, per artifact. Items 1 to 64. - `settings` (SourceSettings): The block for `kind`, where the kind has one. Only git has settings today, and only a push source needs them. - `git` (GitSourceSettings): GitSourceSettings is what a git source adds. Today that is only which branches a push source listens to. - `branches` (array of string): Branches whose pushes publish, exact or with a trailing `*`; `*` alone is every branch. Required on a push source and ignored on a request source. Every publish tags the version with the branch name, floating, and `sha-`. Items at most 32. - `pull_request_comment` (PullRequestComment): What the comment on a pull request carries; unset is SUMMARY. Read on a push source only. enum.defined_only = true One of `PULL_REQUEST_COMMENT_UNSPECIFIED`, `PULL_REQUEST_COMMENT_SUMMARY`, `PULL_REQUEST_COMMENT_FULL`, `PULL_REQUEST_COMMENT_OFF`. - `status` (Status): One of `STATUS_UNSPECIFIED`, `STATUS_READY`, `STATUS_NEEDS_ATTENTION`. Read-only. - `status_reason` (string): Why the status left READY. Empty while ready. Read-only. - `created_by` (ActorRef): ActorRef is a lightweight reference to the user or agent that performed an action. Server-populated on all resource responses. Clients should never send this. Read-only. - `id` (string): The actor's typed id: a `usr-` user id or an `sa-` service account id. - `display_name` (string): Human-readable name (e.g., "John Smith", "deploy-bot"). - `email` (string): Email address (empty for non-human actors). - `created_at` (Timestamp): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC. Read-only. - `updated_at` (Timestamp): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC. Read-only. - `credential_id` (string): Pattern `^cred-[0-9a-z]+$`. - `integration_id` (string): Pattern `^int-[0-9a-z]+$`.