{"id":21356421,"url":"https://github.com/equinix/ne-go","last_synced_at":"2025-07-13T00:31:19.310Z","repository":{"id":42655423,"uuid":"283697373","full_name":"equinix/ne-go","owner":"equinix","description":"Network Edge client library in Go","archived":false,"fork":false,"pushed_at":"2024-09-11T23:46:39.000Z","size":357,"stargazers_count":3,"open_issues_count":6,"forks_count":7,"subscribers_count":10,"default_branch":"main","last_synced_at":"2024-09-12T09:36:21.929Z","etag":null,"topics":["equinix","equinix-platform","network-edge","nfv","sdn"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/equinix.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-30T07:14:03.000Z","updated_at":"2024-09-11T23:29:05.000Z","dependencies_parsed_at":"2023-12-14T23:45:35.781Z","dependency_job_id":"53a104d5-4ea6-402d-b24e-fc2532b94072","html_url":"https://github.com/equinix/ne-go","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equinix%2Fne-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equinix%2Fne-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equinix%2Fne-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equinix%2Fne-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/equinix","download_url":"https://codeload.github.com/equinix/ne-go/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225844870,"owners_count":17533160,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["equinix","equinix-platform","network-edge","nfv","sdn"],"created_at":"2024-11-22T04:31:51.732Z","updated_at":"2024-11-22T04:31:52.423Z","avatar_url":"https://github.com/equinix.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Equinix Network Edge Go client\n\nEquinix Network Edge (NE) client library written in Go.\n\n[![Build Status](https://travis-ci.com/equinix/ne-go.svg?branch=master)](https://travis-ci.com/github/equinix/ne-go)\n[![Go Report Card](https://goreportcard.com/badge/github.com/equinix/ne-go)](https://goreportcard.com/report/github.com/equinix/ne-go)\n[![GoDoc](https://godoc.org/github.com/equinix/ne-go?status.svg)](https://godoc.org/github.com/equinix/ne-go)\n![GitHub](https://img.shields.io/github/license/equinix/ne-go)\n\n---\n\n## Purpose\n\nEquinix Network Edge client library was written in Go for purpose of managing NE\nresources from Terraform provider plugin.\n\nLibrary gives possibility to manage virtual network devices and associated network\nservices.\n\n**NOTE**: Scope of this library is limited to needs of Terraform provider plugin\nand it is not providing full capabilities of Equinix Network Edge API\n\n## Usage\n\n### Code\n\n1. Add ne-go module to import statement.\n   In below example, Equinix `oauth2-go` module is imported as well\n\n   ```go\n   import (\n   \"github.com/equinix/oauth2-go\"\n   \"github.com/equinix/ne-go\"\n   )\n   ```\n\n2. Define baseURL that will be used in all REST API requests\n\n    ```go\n    baseURL := \"https://api.equinix.com\"\n    ```\n\n3. Create oAuth configuration and oAuth enabled `http.Client`\n\n    ```go\n    authConfig := oauth2.Config{\n      ClientID:     \"someClientId\",\n      ClientSecret: \"someSecret\",\n      BaseURL:      baseURL}\n    ctx := context.Background()\n    authClient := authConfig.New(ctx)\n    ```\n\n4. Create NE REST client with a given `baseURL` and oauth's `http.Client`\n\n    ```go\n    var neClient ne.Client = ne.NewClient(ctx, baseURL, authClient)\n    ```\n\n5. Use NE client to perform some operation i.e. **get device** details\n\n    ```go\n    device, err := neClient.GetDevice(\"existingDeviceUUID\")\n    if err != nil {\n      log.Printf(\"Error while fetching device - %v\", err)\n    } else {\n      log.Printf(\"Retrieved device - %+v\", device)\n    }\n    ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fequinix%2Fne-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fequinix%2Fne-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fequinix%2Fne-go/lists"}