SourceHut GraphQL API

https://docs.sourcehut.org
Admin
SourceHut is a collection of open-source developer services, and this documentation provides details...
Tokens:151,752
Snippets:663
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### SetupIntent Interface

Source: https://docs.sourcehut.org/meta

Represents a setup intent, used for initiating payment method setup.

```APIDOC
## SetupIntent

### Description
Represents a setup intent, used for initiating payment method setup.

### Fields
- **id** (String!) - Unique identifier for the setup intent.
- **status** (SetupIntentStatus!) - The status of the setup intent.
- **method** (PaymentMethod) - The payment method being set up.
```

--------------------------------

### Setup Intent Creation API

Source: https://docs.sourcehut.org/meta

Creates a setup intent for adding a new payment method to the authenticated user's account. This endpoint is for internal use.

```APIDOC
## POST /api/payment-methods/setup-intent

### Description
Creates a setup intent for adding a new payment method to the authenticated user's account.

### Method
POST

### Endpoint
/api/payment-methods/setup-intent

### Parameters
No parameters required.

### Request Example
```json
{
  "query": "mutation CreateSetupIntent { createSetupIntent { id, status } }"
}
```

### Response
#### Success Response (200)
- **SetupIntent** (Object) - An object representing the setup intent.
  - **id** (String) - The unique identifier for the setup intent.
  - **status** (String) - The current status of the setup intent (e.g., 'requires_payment_method').

#### Response Example
```json
{
  "data": {
    "createSetupIntent": {
      "id": "seti_123abc",
      "status": "requires_payment_method"
    }
  }
}
```
```

--------------------------------

### Create Setup Intent for Payment Method (GraphQL)

Source: https://docs.sourcehut.org/meta

Creates a setup intent for adding a new payment method to the authenticated user's account. This operation returns a SetupIntent object.

```graphql
query createSetupIntent {
    createSetupIntent {
        id
        status
        method {
            ...PaymentMethod
        }
    }
}

```

--------------------------------

### SetupIntentStatus Enum

Source: https://docs.sourcehut.org/meta

Defines the possible statuses for a setup intent.

```APIDOC
## SetupIntentStatus

### Description
Defines the possible statuses for a setup intent.

### Enum Values
- **PENDING**
- **PROCESSING**
- **SUCCEEDED**
- **CANCELLED**
```

--------------------------------

### POST /finalizeSetupIntent

Source: https://docs.sourcehut.org/meta

Finalizes a setup intent, typically after a payment method has been successfully set up.

```APIDOC
## POST /finalizeSetupIntent

### Description
Finalizes a setup intent.

### Method
POST

### Endpoint
/finalizeSetupIntent

### Parameters
#### Request Body
- **intentID** (String!) - Required - The ID of the SetupIntent to finalize.

### Request Example
```json
{
  "query": "mutation finalizeSetupIntent($intentID: String!) { finalizeSetupIntent(intentID: $intentID) { id } }",
  "variables": {
    "intentID": "seti_67890fghij"
  }
}
```

### Response
#### Success Response (200)
- **SetupIntent** - Returns the finalized SetupIntent object.

#### Response Example
```json
{
  "id": "seti_67890fghij",
  "status": "succeeded",
  "method": { ...PaymentMethod }
}
```
```

--------------------------------

### Finalize Setup Intent

Source: https://docs.sourcehut.org/meta

Finalizes a setup intent, which is an internal operation. It requires the setup intent's ID and returns the SetupIntent object, including its status and associated payment method.

```graphql
query finalizeSetupIntent($intentID: String!) {
    finalizeSetupIntent(intentID: $intentID) {
        id
        status
        method {
            ...PaymentMethod
        }
    }
}
```

--------------------------------

### Start Job API

Source: https://docs.sourcehut.org/builds

Queues a pending job to start its execution. This operation is used to move a job from a pending state to a running state.

```APIDOC
## POST /jobs/{jobID}/start

### Description
Queues a pending job to start its execution. This operation is used to move a job from a pending state to a running state.

### Method
POST

### Endpoint
/jobs/{jobID}/start

### Parameters
#### Path Parameters
- **jobID** (Int!) - Required - The ID of the job to start.

### Request Example
```graphql
query start($jobID: Int!) {
    start(jobID: $jobID) {
        id
        created
        updated
        status
        manifest
        note
        tags
        visibility
        image
        runner
        owner {
            ...Entity
        }
        group {
            ...JobGroup
        }
        tasks {
            ...Task
        }
        artifacts {
            ...Artifact
        }
        log {
            ...Log
        }
        secrets {
            ...Secret
        }
    }
}
```

### Response
#### Success Response (200)
- **Job** - The details of the started job.

#### Response Example
```json
{
  "id": "string",
  "created": "datetime",
  "updated": "datetime",
  "status": "string",
  "manifest": {},
  "note": "string",
  "tags": ["string"],
  "visibility": "string",
  "image": "string",
  "runner": {},
  "owner": {},
  "group": {},
  "tasks": [{}],
  "artifacts": [{}],
  "log": {},
  "secrets": [{}]
}
```
```

--------------------------------

### Start Job (GraphQL)

Source: https://docs.sourcehut.org/builds

Queues a pending job for execution by its job ID. This operation transitions a job from a pending state to a running state. Returns the updated Job object.

```GraphQL
query start($jobID: Int!) {
    start(jobID: $jobID) {
        id
        created
        updated
        status
        manifest
        note
        tags
        visibility
        image
        runner
        owner {
            ...Entity
        }
        group {
            ...JobGroup
        }
        tasks {
            ...Task
        }
        artifacts {
            ...Artifact
        }
        log {
            ...Log
        }
        secrets {
            ...Secret
        }
    }
}
```

--------------------------------

### startGroup - Starts a pending job group

Source: https://docs.sourcehut.org/builds

Initiates a job group that is currently in a pending state. This operation requires read/write access to jobs.

```APIDOC
## startGroup

### Description
Starts a pending job group.

### Method
POST

### Endpoint
/jobs/startGroup

### Parameters
#### Query Parameters
- **groupId** (Int!) - Required - The ID of the job group to start.

### Request Example
```graphql
{
    "query": "mutation startGroup($groupId: Int!) { startGroup(groupId: $groupId) { id created note owner { ...Entity } jobs { ...Job } triggers { ...Trigger } } }",
    "variables": {
        "groupId": 123
    }
}
```

### Response
#### Success Response (200)
- **JobGroup** (Object) - An object representing the started job group.
  - **id** (Int!) - The unique identifier for the job group.
  - **created** (Time!) - The timestamp when the job group was created.
  - **note** (String) - An optional note associated with the job group.
  - **owner** (Object) - Information about the owner of the job group.
  - **jobs** (Array<Object>) - A list of jobs within the group.
  - **triggers** (Array<Object>) - A list of triggers associated with the group.

#### Response Example
```json
{
    "data": {
        "startGroup": {
            "id": 123,
            "created": "2023-10-27T10:00:00Z",
            "note": "Initial job group",
            "owner": { ... },
            "jobs": [ { ... } ],
            "triggers": [ { ... } ]
        }
    }
}
```
```

--------------------------------

### Start Job Group API Query

Source: https://docs.sourcehut.org/builds

Initiates a pending job group by its ID. This mutation requires read-write access to jobs. It returns the created JobGroup object, including its ID, creation timestamp, owner details, associated jobs, and triggers.

```graphql
query startGroup($groupId: Int!) {
    startGroup(groupId: $groupId) {
        id
        created
        note
        owner {
            ...Entity
        }
        jobs {
            ...Job
        }
        triggers {
            ...Trigger
        }
    }
}

```

--------------------------------

### Settings Object

Source: https://docs.sourcehut.org/git

Configuration settings for specific instances.

```APIDOC
## Settings Object

### Description
Instance-specific configuration settings.

### Fields
- **sshUser** (String!) - The SSH username for the instance.
```

--------------------------------

### Create Product (GraphQL)

Source: https://docs.sourcehut.org/meta

Creates a new paid product. Requires the product name and a list of prices as arguments. Returns the newly created Product object.

```graphql
query createProduct($name: String!, $prices: [ProductPriceInput!]!) {
    createProduct(name: $name, prices: $prices) {
        id
        name
        prices {
            ...ProductPrice
        }
        retired
    }
}

```

--------------------------------

### Create New Git Repository

Source: https://docs.sourcehut.org/git

Creates a new git repository with specified name, visibility, and an optional description. If a clone URL is provided, the repository will be initialized by cloning from that URL. Requires appropriate repository write access.

```graphql
query createRepository($name: String!, $visibility: Visibility!, $description: String, $cloneUrl: String) {
    createRepository(name: $name, visibility: $visibility, description: $description, cloneUrl: $cloneUrl) {
        id
        created
        updated
        owner {
            ...Entity
        }
        name
        description
        visibility
        readme
        access
        acls {
            ...ACLCursor
        }
        objects {
            ...Object
        }
        object {
            ...Object
        }
        references {
            ...ReferenceCursor
        }
        reference {
            ...Reference
        }
        HEAD {
            ...Reference
        }
        log {
            ...CommitCursor
        }
        path {
            ...TreeEntry
        }
        revparse_single {
            ...Commit
        }
        repoPath
    }
}
```

--------------------------------

### Object: Settings

Source: https://docs.sourcehut.org/builds

Represents system settings.

```APIDOC
## Object: Settings

### Description
Represents system settings.

### Fields
- **sshUser** (String!) - The default SSH username.
- **buildTimeout** (String!) - The default build timeout duration.
```

--------------------------------

### StripeSetupIntent Object

Source: https://docs.sourcehut.org/meta

Represents a SetupIntent specifically for Stripe, including Stripe-specific fields.

```APIDOC
## StripeSetupIntent

### Description
Represents a SetupIntent specifically for Stripe, including Stripe-specific fields.

### Fields
- **id** (String!) - Unique identifier for the setup intent.
- **status** (SetupIntentStatus!) - The status of the setup intent.
- **method** (PaymentMethod) - The payment method being set up.
- **publicKey** (String) - Stripe public key.
- **clientSecret** (String) - Stripe client secret.
```

--------------------------------

### Get User by Username (GraphQL)

Source: https://docs.sourcehut.org/meta

Retrieves detailed information about a specific user based on their username. Requires the 'username' argument of type String!.

```graphql
query user($username: String!) {
    user(username: $username) {
        id
        created
        updated
        canonicalName
        username
        email
        url
        location
        bio
        sshKeys {
            ...SSHKeyCursor
        }
        pgpKeys {
            ...PGPKeyCursor
        }
        paymentStatus
        paymentDue
        subscription {
            ...BillingSubscription
        }
        invoices {
            ...InvoiceCursor
        }
        billingAddress {
            ...BillingAddress
        }
        paymentMethods {
            ...PaymentMethod
        }
        defaultPaymentMethod {
            ...PaymentMethod
        }
        userType
        receivesPaidServices
        suspensionNotice
    }
}
```

--------------------------------

### Get User by ID (GraphQL)

Source: https://docs.sourcehut.org/meta

Retrieves a specific user's information using their unique integer ID. Requires the 'id' argument of type Int!.

```graphql
query userByID($id: Int!) {
    userByID(id: $id) {
        id
        created
        updated
        canonicalName
        username
        email
        url
        location
        bio
        sshKeys {
            ...SSHKeyCursor
        }
        pgpKeys {
            ...PGPKeyCursor
        }
        paymentStatus
        paymentDue
        subscription {
            ...BillingSubscription
        }
        invoices {
            ...InvoiceCursor
        }
        billingAddress {
            ...BillingAddress
        }
        paymentMethods {
            ...PaymentMethod
        }
        defaultPaymentMethod {
            ...PaymentMethod
        }
        userType
        receivesPaidServices
        suspensionNotice
    }
}
```

--------------------------------

### GraphQL API - man.sr.ht

Source: https://docs.sourcehut.org/man

Documentation for the man.sr.ht GraphQL API, including available queries and mutations.

```APIDOC
## GraphQL API - man.sr.ht

### Description
This API provides access to SourceHut's man.sr.ht service via GraphQL. It allows querying for version information and performing mutations such as deleting a user.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
None

#### Request Body
- **query** (String!) - The GraphQL query or mutation to execute.
- **variables** (Object) - Variables to be used with the query.

### Request Example
```json
{
  "query": "query { version { major minor patch } }"
}
```

### Response
#### Success Response (200)
- **data** (Object) - The result of the GraphQL query or mutation.
  - **version** (Object) - Information about the API version.
    - **major** (Int!) - The major version number.
    - **minor** (Int!) - The minor version number.
    - **patch** (Int!) - The patch version number.
    - **deprecationDate** (Time) - The date this API version is scheduled for deprecation, or null.

#### Response Example
```json
{
  "data": {
    "version": {
      "major": 1,
      "minor": 0,
      "patch": 0,
      "deprecationDate": null
    }
  }
}
```

---

## Mutations

### deleteUser

#### Description
Deletes the authenticated user's account. This is intended for internal use only.

#### Method
POST

#### Endpoint
/graphql

#### Parameters
##### Request Body
- **query** (String!) - The GraphQL mutation to execute.
  - Example: `mutation { deleteUser }`

#### Request Example
```json
{
  "query": "mutation { deleteUser }"
}
```

#### Response
##### Success Response (200)
- **data** (Object)
  - **deleteUser** (Int!) - Likely indicates success or status of the deletion.

##### Response Example
```json
{
  "data": {
    "deleteUser": 1 
  }
}
```

---

## Definitions

### Boolean
SCALAR
The `Boolean` scalar type represents `true` or `false`.

### Cursor
SCALAR

### Float
SCALAR
The `Float` scalar type represents signed double-precision fractional values as specified by IEEE 754.

### ID
SCALAR
The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

### Int
SCALAR
The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

### String
SCALAR
The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

### Time
SCALAR

### Upload
SCALAR

### Version
OBJECT
**Fields**
  1. `**major**`-Int!
  2. `**minor**`-Int!
  3. `**patch**`-Int!
  4. `**deprecationDate**`-Time
     * If this API version is scheduled for deprecation, this is the date on which it will stop working; or null if this API version is not scheduled for deprecation.

---

## Directives

### @defer

#### Description
Directs the executor to defer this fragment when the `if` argument is true or undefined.

#### Arguments
  1. `**if**`-Boolean
     * Deferred when true or undefined.
  2. `**label**`-String
     * Unique name

---

### @deprecated

#### Description
Marks an element of a GraphQL schema as no longer supported.

#### Arguments
  1. `**reason**`-String
     * Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by [CommonMark](https://commonmark.org/).

---

### @include

#### Description
Directs the executor to include this field or fragment only when the `if` argument is true.

#### Arguments
  1. `**if**`-Boolean!
     * Included when true.

---

### @internal

#### Description
This used to decorate fields which are for internal use, and are not available to normal API users.

---

### @oneOf

#### Description
Indicates exactly one field must be supplied and this field must not be `null`.

---

### @skip

#### Description
Directs the executor to skip this field or fragment when the `if` argument is true.

#### Arguments
  1. `**if**`-Boolean!
     * Skipped when true.

---

### @specifiedBy

#### Description
Exposes a URL that specifies the behavior of this scalar.

#### Arguments
  1. `**url**`-String!
     * The URL that specifies the behavior of this scalar.

```

--------------------------------

### GraphQL Query: Get a user by their username

Source: https://docs.sourcehut.org/builds

Retrieves a specific user's details using their unique username. This query requires the 'username' argument and returns a User object.

```graphql
query userByName($username: String!) {
    userByName(username: $username) {
        id
        created
        updated
        canonicalName
        username
        email
        url
        location
        bio
        jobs {
            ...JobCursor
        }
    }
}
```

--------------------------------

### Products Query

Source: https://docs.sourcehut.org/meta

Retrieves a list of all available paid subscription products.

```APIDOC
## GET /graphql

### Description
Retrieves a list of all available paid subscription products.

### Method
POST

### Endpoint
/graphql

### Parameters
No parameters required.

### Request Example
```graphql
query products {
    products {
        id
        name
        prices {
            ...ProductPrice
        }
        retired
    }
}
```

### Response
#### Success Response (200)
- **id** (Int!) - The product ID.
- **name** (String!) - The name of the product.
- **prices** (ProductPrice[]) - A list of prices for the product.
- **retired** (Boolean!) - Indicates if the product is retired.
```

--------------------------------

### Query Available Products - GraphQL

Source: https://docs.sourcehut.org/meta

Retrieves a list of all paid subscription products available for purchase.

```graphql
query products {
    products {
        id
        name
        prices {
            ...ProductPrice
        }
        retired
    }
}

```

--------------------------------

### GraphQL Query: Get a user by their ID

Source: https://docs.sourcehut.org/builds

Fetches details of a specific user identified by their unique ID. This query requires the 'id' argument and returns a User object with profile information.

```graphql
query userByID($id: Int!) {
    userByID(id: $id) {
        id
        created
        updated
        canonicalName
        username
        email
        url
        location
        bio
        jobs {
            ...JobCursor
        }
    }
}
```

--------------------------------

### GraphQL Query: Get API version information

Source: https://docs.sourcehut.org/builds

Fetches the current version information of the API. Returns a Version object including major, minor, patch numbers, deprecation date, and settings.

```graphql
query version {
    version {
        major
        minor
        patch
        deprecationDate
        settings {
            ...Settings
        }
    }
}
```

--------------------------------

### Product Object

Source: https://docs.sourcehut.org/meta

Represents a paid product available for purchase.

```APIDOC
## Product

### Description
A paid product available for purchase.

### Fields
- **id** (Int!) - Unique identifier for the product.
- **name** (String!) - The name of the product.
- **prices** ( [ProductPrice]!) - A list of prices for the product in different currencies.
- **retired** (Boolean!) - Indicates if the product is retired.
```

--------------------------------

### createUserWebhook - Mutation

Source: https://docs.sourcehut.org/paste

Creates a new user webhook subscription, configuring events, query, and URL for notifications.

```APIDOC
## createUserWebhook

### Description
Creates a new user webhook subscription. When an event from the provided list of events occurs, the 'query' parameter (a GraphQL query) will be evaluated and the results will be sent to the provided URL as the body of an HTTP POST request. The list of events must include at least one event, and no duplicates. This query is evaluated in the webhook context, such that `query { webhook }` may be used to access details of the event which trigged the webhook. The query may not make any mutations.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **config** (UserWebhookInput!) - Configuration object for the new webhook subscription.
  - **events** ([String!]!) - List of events to subscribe to.
  - **query** (String!) - GraphQL query to execute when an event occurs.
  - **url** (String!) - The URL to send webhook notifications to.

### Request Example
```json
{
  "query": "mutation createUserWebhook($config: UserWebhookInput!) { createUserWebhook(config: $config) { id events query url client { ...OAuthClient } deliveries { ...WebhookDeliveryCursor } sample } }",
  "variables": {
    "config": {
      "events": ["PASTE_CREATED"],
      "query": "{ webhook { uuid } }",
      "url": "https://example.com/webhook"
    }
  }
}
```

### Response
#### Success Response (200)
- **createUserWebhook** (WebhookSubscription!) - The newly created webhook subscription object.

#### Response Example
```json
{
  "data": {
    "createUserWebhook": {
      "id": 2,
      "events": ["PASTE_CREATED"],
      "query": "{ webhook { uuid } }",
      "url": "https://example.com/webhook",
      "client": {
        "id": "client-id-def"
      },
      "deliveries": {
        "results": [],
        "cursor": null
      },
      "sample": null
    }
  }
}
```
```

--------------------------------

### Get User by Email Address (GraphQL)

Source: https://docs.sourcehut.org/meta

Fetches user details using their email address. This endpoint has 'PROFILE' scope and 'RO' kind access. Requires the 'email' argument of type String!.

```graphql
query userByEmail($email: String!) {
    userByEmail(email: $email) {
        id
        created
        updated
        canonicalName
        username
        email
        url
        location
        bio
        sshKeys {
            ...SSHKeyCursor
        }
        pgpKeys {
            ...PGPKeyCursor
        }
        paymentStatus
        paymentDue
        subscription {
            ...BillingSubscription
        }
        invoices {
            ...InvoiceCursor
        }
        billingAddress {
            ...BillingAddress
        }
        paymentMethods {
            ...PaymentMethod
        }
        defaultPaymentMethod {
            ...PaymentMethod
        }
        userType
        receivesPaidServices
        suspensionNotice
    }
}
```

--------------------------------

### Product Creation API

Source: https://docs.sourcehut.org/meta

Creates a new paid product. This endpoint is restricted to administrator access.

```APIDOC
## POST /api/products

### Description
Creates a new paid product.

### Method
POST

### Endpoint
/api/products

### Parameters
#### Request Body
- **name** (String!) - Required - The name of the product.
- **prices** (Array of ProductPriceInput!) - Required - An array of price objects for the product.
  - **currency** (String!) - Required - The currency code (e.g., "USD").
  - **amount** (Integer!) - Required - The price amount in the smallest currency unit (e.g., cents).
  - **recurring** (Boolean) - Optional - Whether the price is recurring.

### Request Example
```json
{
  "query": "mutation CreateProduct($name: String!, $prices: [ProductPriceInput!]!) { createProduct(name: $name, prices: $prices) { id, name, prices { currency, amount, recurring } } }",
  "variables": {
    "name": "Premium Subscription",
    "prices": [
      { "currency": "USD", "amount": 999, "recurring": true },
      { "currency": "EUR", "amount": 899, "recurring": true }
    ]
  }
}
```

### Response
#### Success Response (200)
- **Product** (Object) - The newly created product object.
  - **id** (String)
  - **name** (String)
  - **prices** (Array) - An array of price objects associated with the product.
  - **retired** (Boolean)

#### Response Example
```json
{
  "data": {
    "createProduct": {
      "id": "prod-abc",
      "name": "Premium Subscription",
      "prices": [
        { "currency": "USD", "amount": 999, "recurring": true },
        { "currency": "EUR", "amount": 899, "recurring": true }
      ],
      "retired": false
    }
  }
}
```
```

--------------------------------

### Get User Profile Webhook Subscription by ID (GraphQL)

Source: https://docs.sourcehut.org/meta

Retrieves details of a specific user profile webhook subscription using its unique ID. Requires an 'id' argument of type Int!.

```graphql
query profileWebhook($id: Int!) {
    profileWebhook(id: $id) {
        id
        events
        query
        url
        client {
            ...OAuthClient
        }
        deliveries {
            ...WebhookDeliveryCursor
        }
        sample
    }
}
```

--------------------------------

### GraphQL Query: Get authenticated user details

Source: https://docs.sourcehut.org/builds

Fetches information about the currently authenticated user. This query returns a User object containing details such as ID, username, email, location, and associated jobs.

```graphql
query me {
    me {
        id
        created
        updated
        canonicalName
        username
        email
        url
        location
        bio
        jobs {
            ...JobCursor
        }
    }
}
```

--------------------------------

### Publish Website (GraphQL)

Source: https://docs.sourcehut.org/pages

Publishes or updates a website. Creates a new site if the domain does not exist, updates it if it exists on the user's account, and rejects if it exists under another account. Content must be a .tar.gz file. HTTPS is presumed if the protocol is unset.

```graphql
query publish($domain: String!, $content: Upload!, $protocol: Protocol, $subdirectory: String, $siteConfig: SiteConfig) {
    publish(domain: $domain, content: $content, protocol: $protocol, subdirectory: $subdirectory, siteConfig: $siteConfig) {
        id
        created
        updated
        domain
        protocol
        version
        notFound
        acls {
            ...SiteACLCursor
        }
    }
}

```

--------------------------------

### Register New Account with registerAccount

Source: https://docs.sourcehut.org/meta

Registers a new user account. Requires email, username, and password. Optionally accepts a PGP key. Returns a User object with details about the newly created account, including profile information, SSH/PGP keys, payment status, and subscription details.

```graphql
query registerAccount($email: String!, $username: String!, $password: String!, $pgpKey: String) {
    registerAccount(email: $email, username: $username, password: $password, pgpKey: $pgpKey) {
        id
        created
        updated
        canonicalName
        username
        email
        url
        location
        bio
        sshKeys {
            ...SSHKeyCursor
        }
        pgpKeys {
            ...PGPKeyCursor
        }
        paymentStatus
        paymentDue
        subscription {
            ...BillingSubscription
        }
        invoices {
            ...InvoiceCursor
        }
        billingAddress {
            ...BillingAddress
        }
        paymentMethods {
            ...PaymentMethod
        }
        defaultPaymentMethod {
            ...PaymentMethod
        }
        userType
        receivesPaidServices
        suspensionNotice
    }
}

```

--------------------------------

### GraphQL Query: Get List of Pastes

Source: https://docs.sourcehut.org/paste

Retrieves a paginated list of pastes created by the authenticated user. Supports cursor-based pagination for efficient fetching of paste collections. Requires PASTES scope with read-only access.

```graphql
query pastes($cursor: Cursor) {
    pastes(cursor: $cursor) {
        results {
            ...Paste
        }
        cursor
    }
}

```

--------------------------------

### Get SSH Key by Fingerprint (GraphQL)

Source: https://docs.sourcehut.org/meta

Retrieves a specific SSH key using its hexadecimal fingerprint. This endpoint requires 'SSH_KEYS' scope and 'RO' kind access. The 'fingerprint' argument must be a String!.

```graphql
query sshKeyByFingerprint($fingerprint: String!) {
    sshKeyByFingerprint(fingerprint: $fingerprint) {
        id
        created
        lastUsed
        user {
            ...User
        }
        key
        fingerprint
        comment
        username
    }
}
```

--------------------------------

### create - Mutation

Source: https://docs.sourcehut.org/paste

Creates a new paste with the provided files and visibility settings.

```APIDOC
## create

### Description
Creates a new paste from a list of files. The files uploaded must have a content type of text/* and must be decodable as UTF-8. Note that the web UI will replace CRLF with LF in uploads; the GraphQL API does not.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **files** ([Upload]!) - A list of files to include in the paste.
- **visibility** (Visibility!) - The visibility setting for the paste (e.g., PUBLIC, PRIVATE).

### Request Example
```json
{
  "query": "mutation create($files: [Upload!]!, $visibility: Visibility!) { create(files: $files, visibility: $visibility) { id created visibility files { ...File } user { ...Entity } } }",
  "variables": {
    "files": ["<file content>"],
    "visibility": "PUBLIC"
  }
}
```

### Response
#### Success Response (200)
- **create** (Paste!) - The newly created paste object.

#### Response Example
```json
{
  "data": {
    "create": {
      "id": "paste-id-789",
      "created": "2023-01-05T14:00:00Z",
      "visibility": "PUBLIC",
      "files": [],
      "user": {
        "id": "user-id-123"
      }
    }
  }
}
```
```

--------------------------------

### Product Query

Source: https://docs.sourcehut.org/meta

Retrieves information about a specific subscription product available for purchase.

```APIDOC
## GET /graphql

### Description
Retrieves information about a specific subscription product available for purchase.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **id** (Int!) - Required - The ID of the product.

### Request Example
```graphql
query product($id: Int!) {
    product(id: $id) {
        id
        name
        prices {
            ...ProductPrice
        }
        retired
    }
}
```

### Response
#### Success Response (200)
- **id** (Int!) - The product ID.
- **name** (String!) - The name of the product.
- **prices** (ProductPrice[]) - A list of prices for the product.
- **retired** (Boolean!) - Indicates if the product is retired.
```

--------------------------------

### GraphQL Query: Get secrets owned by the user

Source: https://docs.sourcehut.org/builds

Retrieves a list of secrets owned by the authenticated user. It accepts an optional cursor for pagination and returns a SecretCursor object containing secret results and the next cursor.

```graphql
query secrets($cursor: Cursor) {
    secrets(cursor: $cursor) {
        results {
            ...Secret
        }
        cursor
    }
}
```

--------------------------------

### GraphQL Query: Get Authenticated User (me)

Source: https://docs.sourcehut.org/paste

Retrieves the authenticated user's profile information, including their ID, creation date, canonical name, username, and associated pastes. Requires PROFILE scope with read-only access.

```graphql
query me {
    me {
        id
        created
        canonicalName
        pastes {
            ...PasteCursor
        }
        username
    }
}

```

--------------------------------

### Order Product Subscription with orderProductSubscription

Source: https://docs.sourcehut.org/meta

Orders a new paid product subscription. The subscription is initially in a PENDING state and requires payment completion. Requires product ID, currency, interval, autorenew status, and optionally billing address and an idempotency key. Returns a PaymentIntent object with subscription and billing details.

```graphql
query orderProductSubscription($productID: Int!, $currency: Currency!, $interval: PaymentInterval!, $autorenew: Boolean!, $address: BillingAddressInput, $idempotencyKey: String) {
    orderProductSubscription(productID: $productID, currency: $currency, interval: $interval, autorenew: $autorenew, address: $address, idempotencyKey: $idempotencyKey) {
        id
        subscription {
            ...BillingSubscription
        }
        billingAddress {
            ...BillingAddress
        }
        idempotencyKey
        taxRate
        taxDue
        totalDue
        method {
            ...PaymentMethod
        }
        outcome {
            ...PaymentOutcome
        }
    }
}

```

--------------------------------

### GraphQL Query: Get jobs for the authenticated user

Source: https://docs.sourcehut.org/builds

Retrieves a list of jobs submitted by the currently authenticated user. It accepts an optional cursor for pagination and returns a JobCursor object containing job results and the next cursor.

```graphql
query jobs($cursor: Cursor) {
    jobs(cursor: $cursor) {
        results {
            ...Job
        }
        cursor
    }
}
```

--------------------------------

### POST /publish

Source: https://docs.sourcehut.org/pages

Publishes or updates a website. If the domain already exists, it's updated. If the domain is taken by another user, the request fails. A new site is created if the domain is new. Content must be a .tar.gz file with specific formatting. Optionally, a protocol and subdirectory can be specified.

```APIDOC
## POST /publish

### Description
Publishes a website. If the domain already exists on your account, it is updated to a new version. If the domain already exists under someone else's account, the request is rejected. If the domain does not exist, a new site is created. Every user is given exclusive use over the 'username.srht.site' domain, and it requires no special configuration to use. Users may also bring their own domain name, in which case they should consult the configuration docs: https://man.sr.ht/pages.sr.ht. 'content' must be a .tar.gz file. It must contain only directories and regular files of mode 644. Symlinks are not supported. No error is returned for an invalid tarball; the invalid data is simply discarded. If protocol is unset, HTTPS is presumed. If subdirectory is set, only the specified directory is updated. The rest of the files are unchanged.

### Method
POST

### Endpoint
/publish

### Parameters
#### Query Parameters
- **domain** (String!) - Required - The domain name for the website.
- **content** (Upload!) - Required - A .tar.gz file containing the website content.
- **protocol** (Protocol) - Optional - The protocol to use (e.g., HTTP, HTTPS). Defaults to HTTPS.
- **subdirectory** (String) - Optional - If set, only the specified directory within the tarball is published.
- **siteConfig** (SiteConfig) - Optional - Configuration for the site.

### Request Example
```graphql
mutation publish($domain: String!, $content: Upload!, $protocol: Protocol, $subdirectory: String, $siteConfig: SiteConfig) {
    publish(domain: $domain, content: $content, protocol: $protocol, subdirectory: $subdirectory, siteConfig: $siteConfig) {
        id
        created
        updated
        domain
        protocol
        version
        notFound
        acls {
            ...SiteACLCursor
        }
    }
}
```

### Response
#### Success Response (200)
Returns information about the published or updated site.
- **id** (Int!) - The unique identifier for the site.
- **created** (Time!) - The timestamp when the site was created.
- **updated** (Time!) - The timestamp when the site was last updated.
- **domain** (String!) - The domain name of the site.
- **protocol** (Protocol) - The protocol used for the site.
- **version** (Int!) - The version of the site.
- **notFound** (Boolean) - Indicates if the site was not found (should be false on successful publish).
- **acls** (Array<SiteACL>) - A list of Access Control Lists for the site.

#### Response Example
```json
{
  "data": {
    "publish": {
      "id": 1,
      "created": "2023-10-27T10:00:00Z",
      "updated": "2023-10-27T10:00:00Z",
      "domain": "example.srht.site",
      "protocol": "HTTPS",
      "version": 1,
      "notFound": false,
      "acls": []
    }
  }
}
```
```

--------------------------------

### GraphQL Query: Get Webhook Context Information

Source: https://docs.sourcehut.org/paste

Retrieves information about the currently processed webhook event within its execution context. This query is only valid when executed within a webhook context and will error otherwise. Returns UUID, event type, and date.

```graphql
query webhook {
    webhook {
        uuid
        event
        date
    }
}

```

--------------------------------

### GraphQL Query: Get List of User Webhook Subscriptions

Source: https://docs.sourcehut.org/paste

Fetches a paginated list of all user webhook subscriptions. For personal access tokens, it returns all webhooks; for OAuth tokens, it returns webhooks registered for that specific client. Supports cursor-based pagination.

```graphql
query userWebhooks($cursor: Cursor) {
    userWebhooks(cursor: $cursor) {
        results {
            ...WebhookSubscription
        }
        cursor
    }
}

```

--------------------------------

### GraphQL Query: Get User by Username

Source: https://docs.sourcehut.org/paste

Fetches a specific user's profile information by their username. Returns details like ID, creation date, canonical name, username, and their associated pastes. Requires PROFILE scope with read-only access.

```graphql
query user($username: String!) {
    user(username: $username) {
        id
        created
        canonicalName
        pastes {
            ...PasteCursor
        }
        username
    }
}

```

--------------------------------

### POST /createUserWebhook

Source: https://docs.sourcehut.org/lists

Creates a new user webhook subscription. When a specified event occurs, a GraphQL query is evaluated and the results are sent to a provided URL.

```APIDOC
## POST /createUserWebhook

### Description
Creates a new user webhook subscription. When an event from the provided list of events occurs, the 'query' parameter (a GraphQL query) will be evaluated and the results will be sent to the provided URL as the body of an HTTP POST request. The list of events must include at least one event, and no duplicates.
This query is evaluated in the webhook context, such that query { webhook } may be used to access details of the event which trigged the webhook. The query may not make any mutations.

### Method
POST

### Endpoint
/createUserWebhook

### Parameters
#### Request Body
- **config** (UserWebhookInput!) - Required - Configuration for the user webhook subscription.

### Request Example
```json
{
  "config": {
    "url": "http://example.com/webhook",
    "events": ["event1", "event2"],
    "query": "query { webhook { id } }"
  }
}
```

### Response
#### Success Response (200)
- **WebhookSubscription** - Details of the created webhook subscription.

#### Response Example
```json
{
  "id": "wh_123abc",
  "events": ["event1", "event2"],
  "query": "query { webhook { id } }",
  "url": "http://example.com/webhook",
  "client": { ... },
  "deliveries": [],
  "sample": "sample_data"
}
```
```

--------------------------------

### Query Product Information - GraphQL

Source: https://docs.sourcehut.org/meta

Fetches information about a specific subscription product available for purchase, including its ID, name, prices, and retired status. Requires a product ID.

```graphql
query product($id: Int!) {
    product(id: $id) {
        id
        name
        prices {
            ...ProductPrice
        }
        retired
    }
}

```

--------------------------------

### GraphQL Query: Get Paste by ID

Source: https://docs.sourcehut.org/paste

Fetches details of a specific paste using its unique ID. Returns paste information such as ID, creation date, visibility, associated files, and the user who created it. Requires PASTES scope with read-only access.

```graphql
query paste($id: String!) {
    paste(id: $id) {
        id
        created
        visibility
        files {
            ...File
        }
        user {
            ...Entity
        }
    }
}

```

--------------------------------

### repositories

Source: https://docs.sourcehut.org/git

Retrieves a list of repositories that the authenticated user has access to.

```APIDOC
## GET /graphql

### Description
Retrieves a list of repositories that the authenticated user has access to. In the current version, only repositories owned by the authenticated user are returned. Future versions will include repositories the user has explicit or implicit access to.

### Method
GET (or POST for GraphQL queries)

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String!) - The GraphQL query string.
- **variables** (JSON) - Variables for the GraphQL query.

#### Request Body (for POST)
- **query** (String!) - The GraphQL query string.
- **variables** (JSON) - Variables for the GraphQL query.

### Parameters
#### Query Parameters
- **cursor** (Cursor) - A cursor for paginating through the results.
- **filter** (Filter) - A filter object to narrow down the search results.

### Request Example
```graphql
query repositories($cursor: Cursor, $filter: Filter) {
    repositories(cursor: $cursor, filter: $filter) {
        results {
            ...Repository
        }
        cursor
    }
}
```

### Response
#### Success Response (200)
- **data** (Object) - Contains the query results.
  - **repositories** (Object) - Information about the repositories.
    - **results** (Array of Object) - A list of repositories.
    - **cursor** (String) - A cursor for the next page of results.

#### Response Example
```json
{
  "data": {
    "repositories": {
      "results": [
        {
          "id": "repo-123",
          "created": "2023-01-01T10:00:00Z",
          "updated": "2023-01-01T10:00:00Z",
          "owner": {},
          "name": "my-repo",
          "description": "A sample repository.",
          "visibility": "public",
          "readme": "# README",
          "access": null,
          "acls": {},
          "objects": {},
          "object": null,
          "references": {},
          "reference": null,
          "HEAD": null,
          "log": {},
          "path": {},
          "revparse_single": null,
          "repoPath": "my-repo"
        }
      ],
      "cursor": "next_cursor_string"
    }
  }
}
```
```

--------------------------------

### Issue OAuth Authorization Code

Source: https://docs.sourcehut.org/meta

Issues an OAuth 2.0 authorization code, used internally after a user has granted consent. It requires the client's UUID and a string representing the grants requested. The operation does not return any specific data in the example.

```graphql
query issueAuthorizationCode($clientUUID: String!, $grants: String!) {
    issueAuthorizationCode(clientUUID: $clientUUID, grants: $grants) {
    }
}
```

--------------------------------

### GraphQL Query: Get a specific job by ID

Source: https://docs.sourcehut.org/builds

Fetches detailed information about a specific job using its unique ID. This query requires the 'id' argument and returns a Job object containing details like status, manifest, owner, and associated tasks.

```graphql
query job($id: Int!) {
    job(id: $id) {
        id
        created
        updated
        status
        manifest
        note
        tags
        visibility
        image
        runner
        owner {
            ...Entity
        }
        group {
            ...JobGroup
        }
        tasks {
            ...Task
        }
        artifacts {
            ...Artifact
        }
        log {
            ...Log
        }
        secrets {
            ...Secret
        }
    }
}
```

--------------------------------

### Create Artifact (GraphQL)

Source: https://docs.sourcehut.org/builds

Uploads a build artifact for a given job. Requires the job ID, the desired path for the artifact, and the artifact's contents as a file. Returns the created Artifact object.

```GraphQL
query createArtifact($jobId: Int!, $path: String!, $contents: File!) {
    createArtifact(jobId: $jobId, path: $path, contents: $contents) {
        id
        created
        path
        size
        url
    }
}
```

--------------------------------

### GraphQL Query: Get User Webhook Subscription by ID

Source: https://docs.sourcehut.org/paste

Retrieves detailed information about a user's webhook subscription, identified by its ID. Includes events, query, URL, client details, deliveries, and sample data. No specific scope mentioned, implies authenticated access.

```graphql
query userWebhook($id: Int!) {
    userWebhook(id: $id) {
        id
        events
        query
        url
        client {
            ...OAuthClient
        }
        deliveries {
            ...WebhookDeliveryCursor
        }
        sample
    }
}

```
Tokens:
Raw