sourcehut

pages.sr.ht API Documentation

This is the GraphQL API documentation for the SourceHut service pages.sr.ht. It was generated from the service's GraphQL Schema definition.

Queries

me

@access(scope:PROFILE, kind:RO)

Returns the authenticated user.

Returns User!

Example Query 
query me {
    me {
        id
        created
        updated
        canonicalName
        username
        email
        url
        location
        bio
    }
}

sites

@access(scope:SITES, kind:RO)

Returns a list of registered sites on your account.

Returns SiteCursor!

Arguments
  1. cursor - Cursor
Example Query 
query sites($cursor: Cursor) {
    sites(cursor: $cursor) {
        results {
            ...Site
        }
        cursor
    }
}

userWebhook

Returns details of a user webhook subscription by its ID.

Returns WebhookSubscription

Arguments
  1. id - Int!
Example Query 
query userWebhook($id: Int!) {
    userWebhook(id: $id) {
        id
        events
        query
        url
        client {
            ...OAuthClient
        }
        deliveries {
            ...WebhookDeliveryCursor
        }
        sample
    }
}

userWebhooks

Returns a list of user webhook subscriptions. For clients authenticated with a personal access token, this returns all webhooks configured by all GraphQL clients for your account. For clients authenticated with an OAuth 2.0 access token, this returns only webhooks registered for your client.

Returns WebhookSubscriptionCursor!

Arguments
  1. cursor - Cursor
Example Query 
query userWebhooks($cursor: Cursor) {
    userWebhooks(cursor: $cursor) {
        results {
            ...WebhookSubscription
        }
        cursor
    }
}

version

Returns API version information.

Returns Version!

Example Query 
query version {
    version {
        major
        minor
        patch
        deprecationDate
    }
}

webhook

Returns information about the webhook currently being processed. This is not valid during normal queries over HTTP, and will return an error if used outside of a webhook context.

Returns WebhookPayload!

Example Query 
query webhook {
    webhook {
        uuid
        event
        date
    }
}

Mutations

createUserWebhook

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.

Returns WebhookSubscription!

Arguments
  1. config - UserWebhookInput!
Example Query 
query createUserWebhook($config: UserWebhookInput!) {
    createUserWebhook(config: $config) {
        id
        events
        query
        url
        client {
            ...OAuthClient
        }
        deliveries {
            ...WebhookDeliveryCursor
        }
        sample
    }
}

deleteUser

@internal

Deletes the authenticated user's account. Internal use only.

Returns Int!

Example Query 
query deleteUser {
    deleteUser {
    }
}

deleteUserWebhook

Deletes a user webhook. Any events already queued may still be delivered after this request completes. Clients authenticated with a personal access token may delete any webhook registered for their account, but authorized OAuth 2.0 clients may only delete their own webhooks. Manually deleting a webhook configured by a third-party client may cause unexpected behavior with the third-party integration.

Returns WebhookSubscription!

Arguments
  1. id - Int!
Example Query 
query deleteUserWebhook($id: Int!) {
    deleteUserWebhook(id: $id) {
        id
        events
        query
        url
        client {
            ...OAuthClient
        }
        deliveries {
            ...WebhookDeliveryCursor
        }
        sample
    }
}

publish

@access(scope:PAGES, kind:RW)

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.

Returns Site!

Arguments
  1. domain - String!
  2. content - Upload!
  3. protocol - Protocol
  4. subdirectory - String
  5. siteConfig - SiteConfig
Example Query 
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
    }
}

unpublish

@access(scope:SITES, kind:RW)

Deletes a previously published website.

If protocol is unset, HTTPS is presumed.

Returns Site

Arguments
  1. domain - String!
  2. protocol - Protocol
Example Query 
query unpublish($domain: String!, $protocol: Protocol) {
    unpublish(domain: $domain, protocol: $protocol) {
        id
        created
        updated
        domain
        protocol
        version
        notFound
    }
}

Definitions

AccessKind

Enum Values
  1. RO
  2. RW

AccessScope

Enum Values
  1. PROFILE
  2. SITES
  3. PAGES

Boolean

The Boolean scalar type represents true or false.

Cursor

Entity

Fields
  1. id - Int!
  2. created - Time!
  3. updated - Time!
  4. canonicalName - String!
    • The canonical name of this entity. For users, this is their username prefixed with '~'. Additional entity types will be supported in the future.

FileConfig

Provides a way to configure options for a set of files matching the glob pattern.

Fields
  1. glob - String!
  2. options - FileOptions!

FileOptions

Options for a file being served.

Fields
  1. cacheControl - String
    • Value of the Cache-Control header to be used when serving the file.

Float

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

ID

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

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

OAuthClient

Fields
  1. uuid - String!

Protocol

Enum Values
  1. HTTPS
  2. GEMINI

Site

A published website

Fields
  1. id - Int!
  2. created - Time!
  3. updated - Time!
  4. domain - String!
    • Domain name the site services
  5. protocol - Protocol!
    • The site protocol
  6. version - String!
    • SHA-256 checksum of the source tarball (uncompressed)
  7. notFound - String
    • Path to the file to serve for 404 Not Found responses

SiteConfig

Fields
  1. notFound - String
    • Path to the file to serve for 404 Not Found responses
  2. fileConfigs - [FileConfig]

SiteCursor

A cursor for enumerating site entries

If there are additional results available, the cursor object may be passed back into the same endpoint to retrieve another page. If the cursor is null, there are no remaining results to return.

Fields
  1. results - [Site]!
  2. cursor - Cursor

SiteEvent

Fields
  1. uuid - String!
  2. event - WebhookEvent!
  3. date - Time!
  4. site - Site!

String

The Stringscalar 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

Upload

User

Fields
  1. id - Int!
  2. created - Time!
  3. updated - Time!
  4. canonicalName - String!
  5. username - String!
  6. email - String!
  7. url - String
  8. location - String
  9. bio - String

UserWebhookInput

Fields
  1. url - String!
  2. events - [WebhookEvent]!
  3. query - String!

UserWebhookSubscription

Fields
  1. id - Int!
  2. events - [WebhookEvent]!
  3. query - String!
  4. url - String!
  5. client - OAuthClient
  6. deliveries - WebhookDeliveryCursor!
  7. sample - String!

Version

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.

WebhookDelivery

Fields
  1. uuid - String!
  2. date - Time!
  3. event - WebhookEvent!
  4. subscription - WebhookSubscription!
  5. requestBody - String!
  6. responseBody - String
    • These details are provided only after a response is received from the remote server. If a response is sent whose Content-Type is not text/*, or cannot be decoded as UTF-8, the response body will be null. It will be truncated after 64 KiB.
  7. responseHeaders - String
  8. responseStatus - Int

WebhookDeliveryCursor

A cursor for enumerating a list of webhook deliveries

If there are additional results available, the cursor object may be passed back into the same endpoint to retrieve another page. If the cursor is null, there are no remaining results to return.

Fields
  1. results - [WebhookDelivery]!
  2. cursor - Cursor

WebhookEvent

Enum Values
  1. SITE_PUBLISHED
  2. SITE_UNPUBLISHED

WebhookPayload

Fields
  1. uuid - String!
  2. event - WebhookEvent!
  3. date - Time!

WebhookSubscription

Fields
  1. id - Int!
  2. events - [WebhookEvent]!
  3. query - String!
  4. url - String!
  5. client - OAuthClient
    • If this webhook was registered by an authorized OAuth 2.0 client, this field is non-null.
  6. deliveries - WebhookDeliveryCursor!
    • All deliveries which have been sent to this webhook.
  7. sample - String!
    • Returns a sample payload for this subscription, for testing purposes

WebhookSubscriptionCursor

A cursor for enumerating a list of webhook subscriptions

If there are additional results available, the cursor object may be passed back into the same endpoint to retrieve another page. If the cursor is null, there are no remaining results to return.

Fields
  1. results - [WebhookSubscription]!
  2. cursor - Cursor

Directives

@access

Decorates fields for which access requires a particular OAuth 0.0 scope with read or write access.

Arguments
  1. scope - AccessScope!
  2. kind - AccessKind!

@defer

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

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

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

Arguments
  1. if - Boolean!
    • Included when true.

@internal

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

@oneOf

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

@private

This is used to decorate fields which are only accessible with a personal access token, and are not available to clients using OAuth 2.0 access tokens.

@scopehelp

Used to provide a human-friendly description of an access scope

Arguments
  1. details - String!

@skip

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

Arguments
  1. if - Boolean!
    • Skipped when true.

@specifiedBy

Exposes a URL that specifies the behavior of this scalar.

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