### Home Classes Methods

### In Files

- lib/github_api/repos/keys.rb

### Parent

Github::API

### Methods

- #all
- #create
- #delete
- #edit
- #find
- #get
- #list

### Class/Module Index

Quicksearch

- Github
- Github::API
- Github::Activity
- Github::Activity::Events
- Github::Activity::Notifications
- Github::Activity::Starring
- Github::Activity::Watching
- Github::ApiFactory
- Github::Arguments
- Github::Authorization
- Github::Authorizations
- Github::AutoloadHelper
- Github::Client
- Github::Configuration
- Github::Connection
- Github::Constants
- Github::CoreExt
- Github::CoreExt::OrderedHash
- Github::Descendants
- Github::Emojis
- Github::Error
- Github::Error::BadRequest
- Github::Error::ClientError
- Github::Error::Forbidden
- Github::Error::GithubError
- Github::Error::InternalServerError
- Github::Error::InvalidOptions
- Github::Error::NotAcceptable
- Github::Error::NotFound
- Github::Error::RequiredParams
- Github::Error::ServiceError
- Github::Error::ServiceUnavailable
- Github::Error::Unauthorized
- Github::Error::UnknownValue
- Github::Error::UnprocessableEntity
- Github::Error::Validations
- Github::Gists
- Github::Gists::Comments
- Github::GitData
- Github::GitData::Blobs
- Github::GitData::Commits
- Github::GitData::References
- Github::GitData::Tags
- Github::GitData::Trees
- Github::Gitignore
- Github::Issues
- Github::Issues::Assignees
- Github::Issues::Comments
- Github::Issues::Events
- Github::Issues::Labels
- Github::Issues::Milestones
- Github::Jsonable
- Github::Markdown
- Github::Meta
- Github::MimeType
- Github::Normalizer
- Github::Orgs
- Github::Orgs::Members
- Github::Orgs::Teams
- Github::PageIterator
- Github::PageLinks
- Github::PagedRequest
- Github::Pagination
- Github::ParameterFilter
- Github::ParamsHash
- Github::PullRequests
- Github::PullRequests::Comments
- Github::RateLimit
- Github::Repos
- Github::Repos::Collaborators
- Github::Repos::Comments
- Github::Repos::Commits
- Github::Repos::Contents
- Github::Repos::Downloads
- Github::Repos::Forks
- Github::Repos::Hooks
- Github::Repos::Keys
- Github::Repos::Merging
- Github::Repos::PubSubHubbub
- Github::Repos::Statistics
- Github::Repos::Statuses
- Github::Request
- Github::Request::BasicAuth
- Github::Request::Jsonize
- Github::Request::OAuth2
- Github::Resource
- Github::Response
- Github::Response::Header
- Github::Response::Jsonize
- Github::Response::Mashify
- Github::Response::RaiseError
- Github::Response::Xmlize
- Github::ResponseWrapper
- Github::S3Uploader
- Github::Say
- Github::Scopes
- Github::Search
- Github::Users
- Github::Users::Emails
- Github::Users::Followers
- Github::Users::Keys
- Github::Utils
- Github::Utils::Url
- Github::VERSION
- Github::Validations
- Github::Validations::Format
- Github::Validations::Presence
- Github::Validations::Required
- Github::Validations::Token
- Hash

No matching classes.

# Github::Repos::Keys

### Constants

VALID_KEY_OPTIONS

### Public Instance Methods

all(*args) click to toggle source
Alias for: list
create(*args) click to toggle source

Create a key

# Inputs

- `:title` - Required string.

- `:key` - Required string.

# Examples

    github = Github.new
    github.repos.keys.create 'user-name', 'repo-name',
      "title" => "octocat@octomac",
      "key" =>  "ssh-rsa AAA..."

    # File lib/github_api/repos/keys.rb, line 51
    def create(*args)
      arguments(args, :required => [:user, :repo]) do
        sift VALID_KEY_OPTIONS
        assert_required VALID_KEY_OPTIONS
      end

      post_request("/repos/#{user}/#{repo}/keys", arguments.params)
    end

delete(*args) click to toggle source

Delete key

# Examples

    github = Github.new
    github.repos.keys.delete 'user-name', 'repo-name', 'key-id'

    # File lib/github_api/repos/keys.rb, line 87
    def delete(*args)
      arguments(args, :required => [:user, :repo, :key_id])
      params = arguments.params

      delete_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)
    end

edit(*args) click to toggle source

Edit a key

# Inputs

- `:title` - Required string.

- `:key` - Required string.

# Examples

    github = Github.new
    github.repos.keys.edit 'user-name', 'repo-name',
      "title" => "octocat@octomac",
      "key" =>  "ssh-rsa AAA..."

    # File lib/github_api/repos/keys.rb, line 72
    def edit(*args)
      arguments(args, :required => [:user, :repo, :key_id]) do
        sift VALID_KEY_OPTIONS
      end
      params = arguments.params

      patch_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)
    end

find(*args) click to toggle source
Alias for: get
get(*args) click to toggle source

Get a key

# Examples

    github = Github.new
    github.repos.keys.get 'user-name', 'repo-name', 'key-id'

    # File lib/github_api/repos/keys.rb, line 32
    def get(*args)
      arguments(args, :required => [:user, :repo, :key_id])

      get_request("/repos/#{user}/#{repo}/keys/#{key_id}", arguments.params)
    end

Also aliased as: find
list(*args) click to toggle source

List deploy keys

# Examples

    github = Github.new
    github.repos.keys.list 'user-name', 'repo-name'
    github.repos.keys.list 'user-name', 'repo-name' { |key| ... }

    keys = Github::Repos::Keys.new user: 'user-name', repo: 'repo-name'
    keys.list

    # File lib/github_api/repos/keys.rb, line 17
    def list(*args)
      arguments(args, :required => [:user, :repo])

      response = get_request("/repos/#{user}/#{repo}/keys", arguments.params)
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: all

[Validate]

Generated with the Darkfish Rdoc Generator 2.