> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ilitylabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a domain's scan login

> Returns how ility signs in to the domain's site before crawling and scanning it. The password is never returned: `has_password` says whether one is stored. `configured: false` means scans run as an anonymous visitor. `available: false` means scan logins aren't set up on this deployment.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/domains/{slug}/scan-auth
openapi: 3.1.0
info:
  title: ility API
  version: 1.0.0
  description: Read accessibility results and start scans in your ility workspace.
servers:
  - url: https://app.ilitylabs.com
security:
  - apiKey: []
tags:
  - name: Workspaces
  - name: Surfaces
  - name: Domains
  - name: Scans
  - name: Issues
paths:
  /v1/domains/{slug}/scan-auth:
    get:
      tags:
        - Domains
      summary: Get a domain's scan login
      description: >-
        Returns how ility signs in to the domain's site before crawling and
        scanning it. The password is never returned: `has_password` says whether
        one is stored. `configured: false` means scans run as an anonymous
        visitor. `available: false` means scan logins aren't set up on this
        deployment.
      parameters:
        - schema:
            type: string
            minLength: 1
          required: true
          name: slug
          in: path
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanAuth'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ScanAuth:
      type: object
      properties:
        available:
          type: boolean
          description: >-
            False when this deployment cannot store credentials
            (SCAN_CREDENTIAL_KEY unset).
        configured:
          type: boolean
        method:
          anyOf:
            - type: string
              enum:
                - basic
                - form
            - type: 'null'
        username:
          type:
            - string
            - 'null'
        has_password:
          type: boolean
        login_url:
          type:
            - string
            - 'null'
        username_selector:
          type:
            - string
            - 'null'
        password_selector:
          type:
            - string
            - 'null'
        submit_selector:
          type:
            - string
            - 'null'
        logged_in_selector:
          type:
            - string
            - 'null'
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - available
        - configured
        - method
        - username
        - has_password
        - login_url
        - username_selector
        - password_selector
        - submit_selector
        - logged_in_selector
        - updated_at
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
        reason:
          type: string
      required:
        - detail
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An ility API key, such as `ilk_1a2b3c4d_…`. Workspace owners create keys
        under Settings → API keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.