client.remote_hosts.patch

A method of the Remote Hosts endpoint.

patch(id: int, *, name: str = None, type: str = None, url: str = None, description: str = None) → Response

Update some attributes of this Remote Host

API URL: PATCH /remote_hosts/{id}

import civis
client = civis.APIClient()
response = client.remote_hosts.patch(...)

Parameters:

idint

The ID of the remote host.

namestr, optional

The human readable name for the remote host.

typestr, optional

The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce

urlstr, optional

The URL for the remote host.

descriptionstr, optional

The description of the remote host.

Returns:

civis.Response

• idint

  The ID of the remote host.

• namestr

  The human readable name for the remote host.

• typestr

  The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce

• urlstr

  The URL for the remote host.

• descriptionstr

  The description of the remote host.

• my_permission_levelstr

  Your permission level on the object. One of “read”, “write”, or “manage”.

• usercivis.Response

  • idint

    The ID of this user.

  • namestr

    This user’s name.

  • usernamestr

    This user’s username.

  • initialsstr

    This user’s initials.

  • onlinebool

    Whether this user is online.

• created_at : str (date-time)

• updated_at : str (date-time)