# social.nstar.epds.repo.getStatus

> Published by [nstar.social](https://lexicon.garden/identity/did:web:nstar.social)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:web:nstar.social/social.nstar.epds.repo.getStatus)
- [Documentation](https://lexicon.garden/lexicon/did:web:nstar.social/social.nstar.epds.repo.getStatus/docs)
- [Examples](https://lexicon.garden/lexicon/did:web:nstar.social/social.nstar.epds.repo.getStatus/examples)

## Definitions

### `social.nstar.epds.repo.getStatus`

**Type**: `query`

Get the hosting status for a repository, on this server.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes | The DID of the repo. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `rev` | `string` (tid) | No | Optional field, the current rev of the repo, if active=true |
| `active` | `boolean` | Yes |  |
| `status` | `string` | No | If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted. |

## Raw Schema

```json
{
  "id": "social.nstar.epds.repo.getStatus",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "errors": [
          {
            "name": "RepoNotFound"
          }
        ],
        "schema": {
          "type": "object",
          "required": [
            "did",
            "active"
          ],
          "properties": {
            "did": {
              "type": "string",
              "format": "did"
            },
            "rev": {
              "type": "string",
              "format": "tid",
              "description": "Optional field, the current rev of the repo, if active=true"
            },
            "active": {
              "type": "boolean"
            },
            "status": {
              "type": "string",
              "description": "If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.",
              "knownValues": [
                "takendown",
                "suspended",
                "deleted",
                "deactivated",
                "desynchronized",
                "throttled"
              ]
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "did"
        ],
        "properties": {
          "did": {
            "type": "string",
            "format": "did",
            "description": "The DID of the repo."
          }
        }
      },
      "description": "Get the hosting status for a repository, on this server."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```