gists.md

Gists API

Back to the navigation

Creating, editing, deleting and listing gists. Wraps GitHub Gists API.

Additional APIs:

• Comments

List all public gists.

$gists = $github->api('gists')->all('public');

List the authenticated user’s starred gists.

Requires authentication.

$gists = $github->api('gists')->all('starred');

Requires authentication.

List the authenticated user’s gists or if called anonymously, this will return all public gists.

Requires authentication to list your gists.

$gists = $github->api('gists')->all();

Get a single gist

$gist = $github->api('gists')->show(1);

Get a specific revision of a gist

$gist = $github->api('gists')->show(1, 'd189dbd4c5d96442db74ebcb62bb38e661a0c8ce');

Get commits for a single gist

$commits = $github->api('gists')->commits(1);

Create a gist

$data = array(
    'files' => array(
        'filename.txt' => array(
            'content' => 'txt file content'
        ),
    ),
    'public' => true,
    'description' => 'This is an optional description'
);

$gist = $github->api('gists')->create($data);

Creates and returns a public gist.

Update a gist

You can update description.

$data = array(
    'description' => 'This is new description'
);

$gist = $github->api('gists')->update(1234, $data);

You can update content of a previous file's version.

$data = array(
    'files' => array(
        'filename.txt' => array(
            'content' => 'updated txt file content'
        ),
    ),
);
$gist = $github->api('gists')->update(1234, $data);

You can update the filename of a previous file's version.

$data = array(
    'files' => array(
        'filename.txt' => array(
            'filename' => 'new-filename.txt'
        ),
    ),
);
$gist = $github->api('gists')->update(1234, $data);

You can add a new file to the gist.

$data = array(
    'files' => array(
        'new-filename.php' => array(
            'content' => 'a new file content'
        ),
    ),
);
$gist = $github->api('gists')->update(1234, $data);

You can remove a file from the gist.

$data = array(
    'files' => array(
        'filename.txt' => null,
    ),
);
$gist = $github->api('gists')->update(1234, $data);

Delete a gist

$gist = $github->api('gists')->remove(1234);